[DOCSW-418] Dev improvements #120

Author: aheckmann

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+on: pull_request
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ci:
+    name: Test
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Check for broken links
+        run: |
+          set -e
+          output=$(npx mint broken-links)
+          echo "$output"
+          if ! echo "$output" | grep -q '^success '; then
+            echo "Error: Broken links found! Fix the broken links listed above before merging."
+            exit 1
+          fi

CONTRIBUTING.md

@@ -17,24 +17,36 @@ git checkout -b <branch-name>
 ### 3. Make Changes in the Appropriate Page
 Navigate to the relevant documentation page in the repository and make your changes. Ensure that your changes align with our style guide and maintain consistency across the documentation.
 
-### 4. Raise a Pull Request (PR)
+### 4. Preview your changes
+Make sure you are visually happy with your changes.
+
+1. Run `npx mint dev`
+1. A url will be printed to your console. Open it in your browser.
+1. Visit your pages and confirm they look correct.
+
+### 5. Fix broken links
+
+1. Run `npx mint broken-links`
+2. Fix all reported broken links
+
+### 6. Raise a Pull Request (PR)
 Once your changes are ready, raise a pull request (PR) to merge your branch into the `master` branch. Please provide a descriptive title and detailed description of your changes.
 
-### 5. Leave a Clear Commit Message
+### 7. Leave a Clear Commit Message
 When committing your changes, leave a clear and concise message that links to the corresponding issue (if applicable) and explains the fix or enhancement you've made.
 
 ```bash
 git add .
 git commit -m "Fixes #<issue-number>: Description of the fix or enhancement"
 ```
 
-### 6. Link the Issue to the Pull Request
+### 8. Link the Issue to the Pull Request
 In your pull request description, be sure to reference the related issue using GitHub's syntax (`#<issue-number>`). This links the PR to the issue and helps maintain context.
 
-### 7. Sign the Contributor License Agreement (CLA)
+### 9. Sign the Contributor License Agreement (CLA)
 Before we can merge your contribution, you must sign our contributor license agreement (CLA). This agreement ensures that your contributions comply with our licensing terms.
 
-### 8. Assign a Reviewer from Our Team
+### 10. Assign a Reviewer from Our Team
 Once your PR is submitted, a member of our team will be assigned to review your changes. They will provide feedback and may request revisions if necessary. Please respond promptly to any review comments to expedite the merging process.
 
-Thank you for contributing to our documentation! We appreciate your efforts in making our product documentation more comprehensive and user-friendly. If you have any questions or need assistance, feel free to reach out to our team. Happy contributing!
+Thank you for contributing to our documentation! We appreciate your efforts in making our product documentation more comprehensive and user-friendly. If you have any questions or need assistance, feel free to reach out to our team. Happy contributing!

self-hosting/govern/github-oauth.mdx

@@ -25,6 +25,5 @@ Plane also supports GitHub OAuth so your users can sign-in with GitHub instead.
 1. Go to `GitHub` on the Authentication screen of `/god mode`.
 2. Add the client ID + the client secret from the GitHub app you just registered.
 3. Click `Save `.
-<Frame>![](/images/instance-admin/authentication-instance-settings.png)</Frame>
 
 Your Plane instance should now work with GitHub sign-in.

self-hosting/govern/google-oauth.mdx

@@ -29,10 +29,8 @@ First, you will need to identify Plane as an approved OAuth app to Google.
 1. Go to `Google` on the Authentication screen of `/god mode`.
 2. Add the client ID + the client secret from Google API Console.
 3. Click `Save `.
-<Frame>![](/images/instance-admin/authentication-instance-settings.png)</Frame>
-
 
 Your Plane instance should now work with `Sign in with Google`.
 
 
-<Note>We don't restrict domains in with Google OAuth yet. It's on our roadmap.</Note>
+<Note>We don't restrict domains in with Google OAuth yet. It's on our roadmap.</Note>

self-hosting/methods/airgapped-edition.mdx

@@ -165,7 +165,7 @@ Once your air-gapped installation is running, you'll need to activate your works
 You should have received the `license_key.json` file as part of your air-gapped package. If you don't have this file, contact our support team.
 </Note>
 
-1. Go to your [Workspace Settings](/core-concepts/workspaces/overview#workspace-settings) in the Plane application.
+1. Go to your [Workspace Settings](https://docs.plane.so/core-concepts/workspaces/overview#workspace-settings) in the Plane application.
 2. Select **Billing and plans** on the right pane.
 3. Click the **Activate this workspace** button.
     ![Upload license file](/images/activate-license/upload-airgapped-license-file.webp)