feat: adding ci to integrate with oxfmt and build check (#407)

* feat: adding ci to integrate with oxfmt and build check

* fix: formatting

Author: sriramveeraghanta

.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  check-format:
+    name: Check Formatting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: pnpm
+
+      - run: pnpm install --frozen-lockfile
+
+      - run: pnpm check:format
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: pnpm
+
+      - run: pnpm install --frozen-lockfile
+
+      - run: pnpm build

.oxfmtrc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "ignorePatterns": []
+}

docs/.vitepress/config.ts

@@ -196,9 +196,9 @@ export default defineConfig({
 
     socialLinks: [
       { icon: "github", link: "https://github.com/makeplane/plane" },
-        { icon: "discord", link: "https://discord.com/invite/A92xrEGCge" },
-        { icon: "twitter", link: "https://twitter.com/planepowers" },
-        { icon: "linkedin", link: "https://www.linkedin.com/company/planepowers/" },
+      { icon: "discord", link: "https://discord.com/invite/A92xrEGCge" },
+      { icon: "twitter", link: "https://twitter.com/planepowers" },
+      { icon: "linkedin", link: "https://www.linkedin.com/company/planepowers/" },
     ],
 
     nav: [

docs/.vitepress/theme/index.ts

@@ -113,7 +113,7 @@ export default {
           handleTabHash();
           setupTabHashUpdates();
         });
-      }
+      },
     );
   },
 } satisfies Theme;

docs/.vitepress/theme/style.css

@@ -187,10 +187,11 @@
 
   /* Fonts */
   --vp-font-family-base:
-    "Satoshi", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, sans-serif;
+    "Satoshi", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell,
+    sans-serif;
   --vp-font-family-mono:
-    "IBM Plex Mono", ui-monospace, SFMono-Regular, "SF Mono", Menlo, Monaco, Consolas, "Liberation Mono", "Courier New",
-    monospace;
+    "IBM Plex Mono", ui-monospace, SFMono-Regular, "SF Mono", Menlo, Monaco, Consolas,
+    "Liberation Mono", "Courier New", monospace;
 }
 
 /* Dark mode */
@@ -686,7 +687,6 @@ a.VPLink.VPNavBarMenuLink[href*="sign-in"]:hover {
   }
 }
 
-
 /* ================================================
    HERO IMAGE STYLES
    ================================================ */
@@ -874,4 +874,3 @@ article img[src$="#hero-br"] {
 .medium-zoom-image--opened {
   z-index: 1000;
 }
-

docs/ai/plane-ai-credits.md

@@ -135,19 +135,19 @@ Credits provide granular control while remaining predictable. Unlike token-based
 It depends on your plan and how you acquired them. Free plan credits reset monthly with no rollover. Pro plan credits roll over for 1 month, Business for 3 months, and Enterprise plans roll over for up to 12 months. Top-up credits purchased separately are valid for 12 months on all paid plans, regardless of your base plan's rollover period.
 :::
 
-::: details Do all workspace members share the same credit pool? 
+::: details Do all workspace members share the same credit pool?
 Yes. Credits are allocated at the workspace level, creating a shared balance that all members draw from. This prevents the problem of some team members having unused credits while others run out. Admins can set per-user limits if needed to prevent any single member from consuming the entire pool.
 :::
 
-::: details What happens when my workspace runs out of credits? 
+::: details What happens when my workspace runs out of credits?
 You'll receive alerts when your balance reaches 20% and 5% of total capacity, giving you time to respond. Once you hit zero, AI features become unavailable until you top up or your monthly allocation renews. Your existing data, past AI results, and all non-AI functionality remain fully accessible. You just can't request new AI operations.
 :::
 
-::: details Can I switch between plans without losing credits? 
+::: details Can I switch between plans without losing credits?
 Yes, you can change plans anytime. When you switch, your unused credits carry forward and adopt the new plan's rollover rules. If you upgrade mid-month, your increased allocation takes effect immediately. If you downgrade, the change happens at your next billing cycle to avoid losing paid credits.
 :::
 
-::: details How can I monitor my workspace's credit usage? 
+::: details How can I monitor my workspace's credit usage?
 The real-time dashboard shows your remaining balance, consumption history, and trends over time. Before executing any AI action, you'll see a credit cost preview.
 :::
 

docs/authentication/group-sync.md

@@ -23,16 +23,16 @@ Group syncing lets workspace admins map identity provider groups to Plane projec
 1. Navigate to **Workspace Settings → Group syncing**.
 2. Toggle on **Enable group syncing**.
 
-  ![Group syncing](https://media.docs.plane.so/sso/enable-group-sync.webp#hero)
+![Group syncing](https://media.docs.plane.so/sso/enable-group-sync.webp#hero)
 
 ## Configure sync settings
 
-| Setting | Description | Default |
-|---------|-------------|---------|
-| **Sync on login** | Update group membership and project access when a user signs in | Enabled (recommended) |
-| **Offline sync** | Run sync automatically every six hours, without waiting for users to log in | Disabled |
-| **Auto remove** | Automatically remove users from projects when they no longer match the group | Disabled |
-| **Group attribute key** | The identity provider attribute used to identify and sync user groups | `groups` |
+| Setting                 | Description                                                                  | Default               |
+| ----------------------- | ---------------------------------------------------------------------------- | --------------------- |
+| **Sync on login**       | Update group membership and project access when a user signs in              | Enabled (recommended) |
+| **Offline sync**        | Run sync automatically every six hours, without waiting for users to log in  | Disabled              |
+| **Auto remove**         | Automatically remove users from projects when they no longer match the group | Disabled              |
+| **Group attribute key** | The identity provider attribute used to identify and sync user groups        | `groups`              |
 
 Set **Group attribute key** to match exactly what your IdP sends. Common values include `groups` (default), `roles`, `memberOf`, or `custom:groups`.
 
@@ -52,18 +52,19 @@ Repeat for additional group-to-project mappings.
 
 ## What happens on login
 
-| Condition | Result |
-|-----------|--------|
-| User not in workspace, but in a mapped group | Added to workspace as Member, then added to mapped project(s) |
-| User in workspace, in mapped group, not yet in project | Added to project with configured role |
-| User in workspace, in mapped group, already in project | No change |
-| User in workspace, not in any mapped group | No action |
+| Condition                                              | Result                                                        |
+| ------------------------------------------------------ | ------------------------------------------------------------- |
+| User not in workspace, but in a mapped group           | Added to workspace as Member, then added to mapped project(s) |
+| User in workspace, in mapped group, not yet in project | Added to project with configured role                         |
+| User in workspace, in mapped group, already in project | No change                                                     |
+| User in workspace, not in any mapped group             | No action                                                     |
 
 ## When users leave IdP groups
 
 If a user is removed from an IdP group and **Auto remove** is enabled, they're removed from the corresponding project. They are never removed from the workspace.
 
 **These users are never auto-removed**
+
 - Users who were manually added to the project
 - Users who are the sole project admin
 
@@ -86,4 +87,4 @@ Map your `engineering` group to all engineering projects. New engineers get acce
 Map `product-team`, `design-team`, and `marketing-team` to their respective projects. Users only see what's relevant to them.
 
 **Contractor offboarding**  
-Map `contractors` to projects with Guest role and enable Auto remove. Access is revoked the moment they're removed from the IdP group.
+Map `contractors` to projects with Guest role and enable Auto remove. Access is revoked the moment they're removed from the IdP group.

docs/core-concepts/issues/epics.md

@@ -86,6 +86,7 @@ A work item can belong to only one Epic. This ensures clarity in organization an
 :::
 
 ## Duplicate Epics <Badge type="info" text="Pro" />
+
 When you need to create similar Epics or replicate an Epic's structure across projects, Plane allows you to duplicate existing Epics either within the same project or to different projects in your workspace.
 
 To duplicate an Epic, click the ••• menu in the Epic header and select Make a copy. You'll see two options:

docs/core-concepts/issues/overview.md

@@ -46,6 +46,7 @@ Break down larger tasks into smaller, manageable components by creating sub-work
 ![sub-work items](https://media.docs.plane.so/issues/issue-sub-issues.webp#hero)
 
 ## Duplicate work items <Badge type="info" text="Pro" />
+
 When you need to create similar work items or replicate a work item's structure and properties, Plane lets you duplicate existing work items either within the same project or across different projects.
 
 To duplicate a work item, click the **•••** menu in the work item header and select **Make a copy**. You'll see two options:
@@ -124,6 +125,7 @@ Plane allows you to upload different file types directly to the work item. Use t
   CSS, JavaScript, JSON, XML, CSV, SQL
 
 ## Link pages to work items <Badge type="info" text="Pro" />
+
 Connect relevant project pages and wiki documentation to your work items to provide instant access to related context, specifications, or reference materials.
 
 1. Use the **Link pages** button in the work item to open the page linking modal.

docs/core-concepts/pages/overview.md

@@ -134,6 +134,7 @@ Share the page by copying its link to send to your teammates or link it in a wor
 Duplicate an existing page to jumpstart new content.
 
 ### Move Page <Badge type="info" text="Pro" />
+
 Transfer a page to Wiki, Teamspace or a different Project in your workspace.
 
 ### Lock Page