Skip to content

Commit 01e4d89

Browse files
committed
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
2 parents a281a63 + 7c314e7 commit 01e4d89

File tree

147 files changed

+3688
-15013
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

147 files changed

+3688
-15013
lines changed

.agents/skills/update-docs/SKILL.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Scan recent git history for commits that affect user-facing behavior and draft d
1010
## Prerequisites
1111

1212
- You must be in the OpenShell git repository.
13-
- The published docs tree must exist under `fern/pages/`.
14-
- Read `fern/pages/CONTRIBUTING.mdx` before writing any content. It contains the current style guide and formatting rules.
13+
- The published docs tree must exist under `docs/`.
14+
- Read `docs/CONTRIBUTING.mdx` before writing any content. It contains the current style guide and formatting rules.
1515

1616
## When to Use
1717

@@ -48,16 +48,16 @@ For each relevant commit, determine which doc page(s) it affects. Use this mappi
4848

4949
| Code area | Likely doc page(s) |
5050
|---|---|
51-
| `crates/openshell-cli/` (gateway commands) | `fern/pages/sandboxes/manage-gateways.mdx` |
52-
| `crates/openshell-cli/` (sandbox commands) | `fern/pages/sandboxes/manage-sandboxes.mdx` |
53-
| `crates/openshell-cli/` (provider commands) | `fern/pages/sandboxes/manage-providers.mdx` |
54-
| `crates/openshell-cli/` (new top-level command) | May need a new page or `fern/pages/reference/` entry |
55-
| Proxy or policy code | `fern/pages/sandboxes/policies.mdx`, `fern/pages/reference/policy-schema.mdx` |
56-
| Inference code | `fern/pages/inference/configure.mdx` |
57-
| `python/` (SDK changes) | `fern/pages/reference/` or `fern/pages/get-started/quickstart.mdx` |
58-
| `proto/` (API changes) | `fern/pages/reference/` |
59-
| `deploy/` (Dockerfile, Helm) | `fern/pages/sandboxes/manage-gateways.mdx`, `fern/pages/about/architecture.mdx` |
60-
| Community sandbox definitions | `fern/pages/sandboxes/community-sandboxes.mdx` |
51+
| `crates/openshell-cli/` (gateway commands) | `docs/sandboxes/manage-gateways.mdx` |
52+
| `crates/openshell-cli/` (sandbox commands) | `docs/sandboxes/manage-sandboxes.mdx` |
53+
| `crates/openshell-cli/` (provider commands) | `docs/sandboxes/manage-providers.mdx` |
54+
| `crates/openshell-cli/` (new top-level command) | May need a new page or `docs/reference/` entry |
55+
| Proxy or policy code | `docs/sandboxes/policies.mdx`, `docs/reference/policy-schema.mdx` |
56+
| Inference code | `docs/inference/configure.mdx` |
57+
| `python/` (SDK changes) | `docs/reference/` or `docs/get-started/quickstart.mdx` |
58+
| `proto/` (API changes) | `docs/reference/` |
59+
| `deploy/` (Dockerfile, Helm) | `docs/sandboxes/manage-gateways.mdx`, `docs/about/architecture.mdx` |
60+
| Community sandbox definitions | `docs/sandboxes/community-sandboxes.mdx` |
6161

6262
If a commit does not map to any existing page but introduces a user-visible concept, flag it as needing a new page.
6363

@@ -88,7 +88,7 @@ Identify where the new content should go. Follow the page's existing structure.
8888

8989
## Step 5: Draft the Update
9090

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:
9292

9393
- **Active voice, present tense, second person.**
9494
- **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
9797
- **No superlatives.** Say what the feature does, not how great it is.
9898
- **Code examples use `shell` language** for copyable commands, with no `$` prompt prefix.
9999
- **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**.
106106
- **Do not add a duplicate H1**. Fern renders the page title from frontmatter.
107107
- **Always write NVIDIA in all caps.** Wrong: Nvidia, nvidia.
108108
- **Always capitalize OpenShell correctly.** Wrong: openshell, Openshell, openShell.
@@ -118,8 +118,8 @@ When updating an existing page:
118118

119119
When creating a new page:
120120

121-
- Follow the frontmatter template from `fern/pages/CONTRIBUTING.mdx`.
122-
- Add the page to the appropriate section in `fern/versions/latest.yml`.
121+
- Follow the frontmatter template from `docs/CONTRIBUTING.mdx`.
122+
- Add the page to the appropriate section in `docs/index.yml`.
123123

124124
## Step 6: Present the Results
125125

@@ -129,8 +129,8 @@ After drafting all updates, present a summary to the user:
129129
## Doc Updates from Commits
130130
131131
### Updated pages
132-
- `fern/pages/sandboxes/manage-gateways.mdx`: Added `--gpu` flag documentation (from commit abc1234).
133-
- `fern/pages/reference/policy-schema.mdx`: Updated network policy schema for new `tls_inspect` field (from commit def5678).
132+
- `docs/sandboxes/manage-gateways.mdx`: Added `--gpu` flag documentation (from commit abc1234).
133+
- `docs/reference/policy-schema.mdx`: Updated network policy schema for new `tls_inspect` field (from commit def5678).
134134
135135
### New pages needed
136136
- None (or list any new pages created).
@@ -145,13 +145,13 @@ After drafting all updates, present a summary to the user:
145145
After making changes, validate the Fern docs locally:
146146

147147
```bash
148-
fern check
148+
mise run docs
149149
```
150150

151151
If a human needs to inspect rendering while iterating, they can also run:
152152

153153
```bash
154-
fern docs dev
154+
mise run docs:serve
155155
```
156156

157157
Check for:
@@ -177,4 +177,4 @@ User says: "Catch up the docs for everything merged since v0.2.0."
177177
4. Read the commit diffs and current doc pages.
178178
5. Draft updates following the style guide.
179179
6. Present the summary.
180-
7. Run `fern check` to verify.
180+
7. Run `mise run docs` to verify.

.github/workflows/branch-docs.yml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@ name: Branch Docs Preview
33
on:
44
pull_request:
55
paths:
6+
- "docs/**"
67
- "fern/**"
8+
- "mise.toml"
9+
- "tasks/docs.toml"
710
- ".github/workflows/branch-docs.yml"
11+
- ".github/workflows/release-tag.yml"
812

913
permissions:
1014
contents: read
@@ -30,14 +34,18 @@ jobs:
3034
fi
3135
3236
- name: Setup Node.js
33-
if: ${{ steps.fern-preview.outputs.enabled == 'true' }}
3437
uses: actions/setup-node@v6
3538
with:
3639
node-version: "24"
3740

3841
- name: Install Fern CLI
39-
if: ${{ steps.fern-preview.outputs.enabled == 'true' }}
40-
run: npm install -g fern-api
42+
run: |
43+
FERN_VERSION=$(node -p "require('./fern/fern.config.json').version")
44+
npm install -g "fern-api@${FERN_VERSION}"
45+
46+
- name: Validate docs
47+
working-directory: ./fern
48+
run: fern check
4149

4250
- name: Generate preview URL
4351
if: ${{ steps.fern-preview.outputs.enabled == 'true' }}

.github/workflows/docs-build.yml

Lines changed: 0 additions & 134 deletions
This file was deleted.

.github/workflows/docs-preview-pr.yml

Lines changed: 0 additions & 58 deletions
This file was deleted.

.github/workflows/release-tag.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,9 @@ jobs:
399399
node-version: "24"
400400

401401
- name: Install Fern CLI
402-
run: npm install -g fern-api
402+
run: |
403+
FERN_VERSION=$(node -p "require('./fern/fern.config.json').version")
404+
npm install -g "fern-api@${FERN_VERSION}"
403405
404406
- name: Publish Fern docs
405407
env:

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,3 +201,4 @@ architecture/plans
201201
.claude/worktrees/
202202
rfc.md
203203
.worktrees
204+
.z3-trace

AGENTS.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ These pipelines connect skills into end-to-end workflows. Individual skill files
4343
| `python/openshell/` | Python SDK | Python bindings and CLI packaging |
4444
| `proto/` | Protobuf definitions | gRPC service contracts |
4545
| `deploy/` | Docker, Helm, K8s | Dockerfiles, Helm chart, manifests |
46-
| `fern/` | Published docs | Fern site config, navigation, components, and MDX pages |
47-
| `docs/` | Legacy docs source | Sphinx/MyST source retained for migration, comparison, and legacy build tasks |
46+
| `docs/` | Published docs | MDX pages, navigation, and content assets |
47+
| `fern/` | Docs site config | Fern site config, components, and theme assets |
4848
| `.agents/skills/` | Agent skills | Workflow automation for development |
4949
| `.agents/agents/` | Agent personas | Sub-agent definitions (e.g., reviewer, doc writer) |
5050
| `architecture/` | Architecture docs | Design decisions and component documentation |
@@ -187,9 +187,9 @@ ocsf_emit!(event);
187187
## Documentation
188188

189189
- 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.
193193
- 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`.
194194
- Use the `update-docs` skill to scan recent commits and draft doc updates.
195195

0 commit comments

Comments
 (0)