Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
37 changes: 37 additions & 0 deletions .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Docs checks

on:
pull_request:
push:
branches:
- main

permissions:
contents: read

concurrency:
group: docs-check-${{ github.ref }}
cancel-in-progress: true

jobs:
validate:
runs-on: ubuntu-latest
timeout-minutes: 15

steps:
- name: Check out repository
uses: actions/checkout@v5

- name: Set up Node.js
uses: actions/setup-node@v6
with:
node-version: 22
cache: npm

- name: Install dependencies
run: npm ci

- name: Validate documentation
run: npm run check
env:
FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ node_modules/
build/
dist/
imported/
scripts/
# Legacy one-off import generators; maintained documentation scripts are tracked.
scripts/generate-fern.mjs
scripts/import-gitbook.mjs
source-docs/
src/
static/
Expand Down
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,17 @@ Documentation source files live under:

- `fern/docs/pages/` for English pages
- `fern/docs.yml` for English navigation, tabs, redirects, and site configuration
- `fern/translations/<locale>/` for every localized navigation and page overlay
- `fern/translations/<locale>/` for locales handled by Fern's native localization

English is the source of truth. If an English page changes, regenerate the affected
locales with `npm run translations:generate -- --locales=<locale>`. For a deliberate
manual translation, refresh its source hash with
`npm run translations:refresh-manifest -- --locales=<locale>`.

After translation generation, run `npm run translations:polish`. The repository
checks verify all 20 public locales, canonical URLs, internal links, code
samples, and locale configuration.

## Validation

Run Fern validation before opening a pull request:
Expand Down
11 changes: 6 additions & 5 deletions DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use a clean, technical, enterprise SaaS style aligned with the black/white theme

- White default theme with black text, subtle gray borders, and low-noise navigation.
- Dark theme with near-black backgrounds, white text, restrained borders, and code-first contrast.
- 6MM blue as the accent color for links, active navigation, and important technical highlights.
- 6MM teal as the accent color for links, active navigation, and important technical highlights.
- Left navigation, center docs, right page outline.
- Search-first top bar with compact external links and theme/language controls.
- Neutral gray text, restrained borders, and compact spacing.
Expand Down Expand Up @@ -77,10 +77,11 @@ Use separate language routes:
- `/` for English
- `/<locale>/` for each localized version

English is the source of truth. Every translation overlay lives under
`fern/translations/` and uses Fern's native locale routing. Do not mix languages
in one page. Translate by concept, not sentence-by-sentence, and keep API names,
method names, event names, headers, and code identifiers unchanged.
English is the source of truth. Every supported translation uses a Fern-native
overlay under `fern/translations/`. Do not use surrogate locale codes or
standalone locale page trees. Do not mix languages in one page. Translate by
concept, not sentence-by-sentence, and keep API names, method names, event names,
headers, and code identifiers unchanged.

The Docs site intentionally consolidates two Widget-only regional codes:

Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,11 @@ The documentation covers:
fern/
docs.yml # English docs configuration, navigation, theme, redirects
docs/pages/ # English documentation pages
translations/<locale>/ # Fern translation overlays for every locale
translations/<locale>/ # 19 non-English Fern-native overlays, including zh-CN
docs/assets/ # Logos, favicon, brand assets, and downloads
scripts/
generate-translations.mjs # Translation generation and manifest refresh
polish-core-translations.mjs # Deterministic terminology and quality fixes
check-translations.mjs # Locale, SEO, link, asset, and manifest validation
```

Expand Down Expand Up @@ -58,7 +59,10 @@ Preview routes:

```text
English: http://127.0.0.1:3000/home
Chinese: http://127.0.0.1:3000/zh-CN/home
Simplified Chinese: http://127.0.0.1:3000/zh-CN/home
Turkish: http://127.0.0.1:3000/tr/home
Korean: http://127.0.0.1:3000/ko/home
Greek: http://127.0.0.1:3000/el/home
```

## Contributing
Expand Down
45 changes: 18 additions & 27 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,22 @@ translations:
- lang: pt-PT
- lang: es-ES
- lang: tr
- lang: ko
- lang: el
- lang: ar
- lang: ms
- lang: tr-TR

redirects:
# Retired locale prefixes preserve inbound links by falling back to the
# equivalent English page; they are not published Docs locales.
- source: "/uz/:slug*"
destination: "/:slug*"
permanent: true
- source: "/fil/:slug*"
destination: "/:slug*"
permanent: true
- source: "/az/:slug*"
destination: "/:slug*"
permanent: true
- source: "/en-Asia/:slug*"
destination: "/:slug*"
permanent: true
Expand All @@ -57,24 +68,6 @@ redirects:
- source: "/es/:slug*"
destination: "/es-ES/:slug*"
permanent: true
- source: "/uz/:slug*"
destination: "/tr/:slug*"
permanent: true
- source: "/uz-UZ/:slug*"
destination: "/tr/:slug*"
permanent: true
- source: "/fil/:slug*"
destination: "/ms/:slug*"
permanent: true
- source: "/fil-PH/:slug*"
destination: "/ms/:slug*"
permanent: true
- source: "/az/:slug*"
destination: "/tr-TR/:slug*"
permanent: true
- source: "/az-AZ/:slug*"
destination: "/tr-TR/:slug*"
permanent: true
- source: "/:locale/pt/:slug*"
destination: "/pt-PT/:slug*"
permanent: true
Expand Down Expand Up @@ -438,6 +431,7 @@ redirects:

layout:
searchbar-placement: header
tabs-placement: header
page-width: full

tabs:
Expand Down Expand Up @@ -470,7 +464,7 @@ tabs:
icon: fa-duotone fa-shield-check
skip-slug: true
resources:
display-name: "Resources & Support"
display-name: "Integration & Support"
icon: fa-duotone fa-folder-open
skip-slug: true

Expand Down Expand Up @@ -826,7 +820,7 @@ navigation:
layout:
- section: Overview
contents:
- page: Resources & Support
- page: Integration & Support
path: docs/pages/resources/overview.mdx
icon: fa-duotone fa-folder-open
- section: Brand & Assets
Expand Down Expand Up @@ -889,18 +883,15 @@ colors:
light: "#ffffff"

theme:
tabs:
placement: header
style: default
alignment: center
tabs: default
page-actions: toolbar
footer-nav: minimal

logo:
dark: docs/assets/logo-dark.svg
light: docs/assets/logo-light.svg
height: 30
href: https://www.6mm.com
href: /home

favicon: docs/assets/favicon.svg

Expand Down
37 changes: 0 additions & 37 deletions fern/docs/pages/ai-hub/agentic-skills.mdx

This file was deleted.

77 changes: 0 additions & 77 deletions fern/docs/pages/ai-hub/choose-a-setup.mdx

This file was deleted.

60 changes: 0 additions & 60 deletions fern/docs/pages/ai-hub/cli.mdx

This file was deleted.

Loading