Merge branch 'devin/1760816968-update-ai-search-docs' of https://github.com/fern-api/docs into devin/1760816968-update-ai-search-docs

Author: devalog

.github/workflows/auto-merge-on-docs-release.yml

@@ -0,0 +1,50 @@
+# .github/workflows/auto-merge-on-release.yml in docs repo
+name: Auto-merge on Docs Release
+on:
+  repository_dispatch:
+    types: [docs_release]
+
+jobs:
+  merge-dependent-prs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Find and merge dependent PRs
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const version = context.payload.client_payload.version;
+            
+            // Find PRs with matching labels
+            const { data: prs } = await github.rest.pulls.list({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              state: 'open'
+            });
+            
+            for (const pr of prs) {
+              const labels = pr.labels.map(l => l.name);
+              const hasLatestLabel = labels.includes('depends-on: docs@latest');
+              const hasVersionLabel = labels.includes(`depends-on: docs@${version}`);
+              
+              if (hasLatestLabel || hasVersionLabel) {
+                // Check if PR is approved and CI passes
+                const { data: reviews } = await github.rest.pulls.listReviews({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  pull_number: pr.number
+                });
+                
+                const approved = reviews.some(r => r.state === 'APPROVED');
+                
+                if (approved) {
+                  await github.rest.pulls.merge({
+                    owner: context.repo.owner,
+                    repo: context.repo.repo,
+                    pull_number: pr.number,
+                    merge_method: 'squash'
+                  });
+                  
+                  console.log(`Merged PR #${pr.number}: ${pr.title}`);
+                }
+              }
+            }

.github/workflows/vale.yml

@@ -6,6 +6,7 @@ on:
       - '**.md'
       - '.vale/**'
       - '.vale.ini'
+      - '!**/changelog/**'
 
 jobs:
   vale:
@@ -15,9 +16,22 @@ jobs:
       github.event.pull_request.user.login != 'github-actions'
     steps:
       - uses: actions/checkout@v4
-      
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v41
+        with:
+          files: |
+            fern/**/*.md
+            fern/**/*.mdx
+          files_ignore: |
+            **/changelog/**
       - uses: errata-ai/vale-action@reviewdog
+        if: steps.changed-files.outputs.any_changed == 'true'
         with:
-          files: fern
+          files: ${{ steps.changed-files.outputs.all_changed_files }}
+          version: 3.12.0
+          reporter: github-pr-review
+          fail_on_error: false
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.pre-commit-config.yaml

@@ -6,5 +6,6 @@ repos:
         entry: bash -c 'vale --config=.vale.ini "$@"; exit 0' --
         language: system
         files: \.(md|mdx)$
+        exclude: 'changelog/'
         pass_filenames: true
-        verbose: true
+        verbose: true

.vale.ini

@@ -11,7 +11,36 @@ mdx = md
 BasedOnStyles = Microsoft, FernStyles
 
 # Disable specific rules
-Microsoft.GenderBias = NO # Not relevant for technical documentation
-Microsoft.Acronyms = NO # Handled in FernStyles
-Microsoft.Vocab = NO # Too granular for now
+# Not relevant for technical documentation
+Microsoft.GenderBias = NO
+
+# Too granular
+Microsoft.Accessibility = NO
+Microsoft.Passive = NO
+Microsoft.Suspended = NO
+Microsoft.Vocab = NO
+Microsoft.Spacing = NO
+Microsoft.Semicolon = NO # Mostly just picks up code
+Microsoft.SentenceLength = NO # Mostly just picks up code
+Microsoft.Ellipses = NO # Mostly just picks up code
+Microsoft.Dashes = NO
+Microsoft.Foreign = NO
+Microsoft.Plurals = NO
+
+# Not relevant for Fern audience
+Microsoft.GeneralURL = NO
+Microsoft.HeadingAcronyms = NO
+Microsoft.Terms = NO
+
+# Handled in FernStyles
+Microsoft.Acronyms = NO
+Microsoft.Adverbs = NO
+Microsoft.Ellipses = NO
+Microsoft.FirstPerson = NO
+Microsoft.Headings = NO
+Microsoft.HeadingPunctuation = NO
+Microsoft.Hyphens = NO
+Microsoft.We = NO
+
+
 

.vale/styles/FernStyles/Acronyms.yml

@@ -11,10 +11,12 @@ exceptions:
   - API
   - ASP
   - CLI
+  - CNAME
   - CPU
   - CSS
   - CSV
   - DEBUG
+  - DNS
   - DOM
   - DPI
   - FAQ
@@ -54,6 +56,7 @@ exceptions:
   - TBD
   - TCP
   - TODO
+  - TXT
   - URI
   - URL
   - USB
@@ -62,4 +65,22 @@ exceptions:
   - XSS
   - YAML
   - ZIP
-  - MDX # Fern-specific
+  - SEO
+  - TLS
+  - BCL 
+  - LLM 
+  - MDX
+  - SEO 
+  - AWS 
+  - OpenRPC
+  - gRPC
+  - RPC
+  - MCP
+  - JWT
+  - PUT
+  - GET
+  - POST
+  - IDE
+  - RBAC
+  - SAML
+  - OIDC