You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: merge main and resolve tutorial path conflicts
Merge origin/main into docs/structure-cleanup. Resolve rename/rename
conflicts for tutorial files by placing them at docs/get-started/tutorials/,
combining main's fern-to-docs migration with the get-started restructuring.
Made-with: Cursor
| Community sandbox definitions |`docs/sandboxes/community-sandboxes.mdx`|
61
61
62
62
If a commit does not map to any existing page but introduces a user-visible concept, flag it as needing a new page.
63
63
@@ -88,7 +88,7 @@ Identify where the new content should go. Follow the page's existing structure.
88
88
89
89
## Step 5: Draft the Update
90
90
91
-
Write the doc update following the rules in `fern/pages/CONTRIBUTING.mdx`. Key reminders:
91
+
Write the doc update following the rules in `docs/CONTRIBUTING.mdx`. Key reminders:
92
92
93
93
-**Active voice, present tense, second person.**
94
94
-**No unnecessary bold.** Reserve bold for UI labels and parameter names.
@@ -97,12 +97,12 @@ Write the doc update following the rules in `fern/pages/CONTRIBUTING.mdx`. Key r
97
97
-**No superlatives.** Say what the feature does, not how great it is.
98
98
-**Code examples use `shell` language** for copyable commands, with no `$` prompt prefix.
99
99
-**Use `text` fences** for transcripts, logs, or shell sessions that should not be copied verbatim.
100
-
-**Include the SPDX header** if creating a new page.
101
-
-**Match existing Fern frontmatter format** if creating a new page, including `sidebar-title`, `keywords`, `tags`, and `position` when they are relevant. Use frontmatter `slug` only for folder-discovered pages or absolute URL overrides.
102
-
-**Use `sidebar-title` for short nav labels**. For explicit navbar entries, keep relative `slug` values in `fern/versions/latest.yml` instead of page frontmatter.
103
-
-**Keep explicit `page:` entries in `fern/versions/latest.yml`**. Fern still requires them. If the page defines `sidebar-title`, set `page:` to that value. Otherwise set `page:` to the page frontmatter `title`.
104
-
-**Use `skip-slug: true` in `fern/versions/latest.yml`** when a child page should live at the parent section path.
105
-
-**Use `keywords` as a comma-separated string**. When migrating a page from `docs/`, combine the legacy `topics` and `tags` into `keywords` and preserve the legacy `tags` array when it is still useful.
100
+
-**Include the SPDX header as YAML comments in frontmatter** if creating a new page.
101
+
-**Match existing Fern frontmatter format** if creating a new page, including `sidebar-title`, `keywords`, and `position` when they are relevant. Use frontmatter `slug` only for folder-discovered pages or absolute URL overrides.
102
+
-**Use `sidebar-title` for short nav labels**. For explicit navigation entries, keep relative `slug` values in `docs/index.yml` instead of page frontmatter.
103
+
-**Keep explicit `page:` entries in `docs/index.yml`**. Fern still requires them. If the page defines `sidebar-title`, set `page:` to that value. Otherwise set `page:` to the page frontmatter `title`.
104
+
-**Use `skip-slug: true` in `docs/index.yml`** when a child page should live at the parent section path.
105
+
-**Use `keywords` as a comma-separated string**.
106
106
-**Do not add a duplicate H1**. Fern renders the page title from frontmatter.
107
107
-**Always write NVIDIA in all caps.** Wrong: Nvidia, nvidia.
|`architecture/`| Architecture docs | Design decisions and component documentation |
@@ -187,9 +187,9 @@ ocsf_emit!(event);
187
187
## Documentation
188
188
189
189
- When making changes, update the relevant documentation in the `architecture/` directory.
190
-
- When changes affect user-facing behavior, update the relevant published docs pages under `fern/pages/` and navigation in `fern/versions/latest.yml`.
191
-
-`docs/`is retained for legacy Sphinx build tasks and migration/reference work. Do not update it unless the user explicitly asks.
192
-
- Follow the docs style guide in [fern/pages/CONTRIBUTING.mdx](fern/pages/CONTRIBUTING.mdx): active voice, minimal formatting, no filler introductions, `shell` fences for copyable commands, and no duplicate body H1.
190
+
- When changes affect user-facing behavior, update the relevant published docs pages under `docs/` and navigation in `docs/index.yml`.
191
+
-`fern/`contains the Fern site config, components, preview workflow inputs, and publish settings.
192
+
- Follow the docs style guide in [docs/CONTRIBUTING.mdx](docs/CONTRIBUTING.mdx): active voice, minimal formatting, no filler introductions, `shell` fences for copyable commands, and no duplicate body H1.
193
193
- Fern PR previews run through `.github/workflows/branch-docs.yml`, and production publish runs through the `publish-fern-docs` job in `.github/workflows/release-tag.yml`.
194
194
- Use the `update-docs` skill to scan recent commits and draft doc updates.
0 commit comments