Skip to content

Commit 06dcf0f

Browse files
committed
chore: deprecate mkdocs docs
Signed-off-by: Andre Manoel <amanoel@nvidia.com>
1 parent 564ca1a commit 06dcf0f

155 files changed

Lines changed: 332 additions & 15320 deletions

File tree

Some content is hidden

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

.agents/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ Tool-specific directories symlink back here so each harness resolves skills from
2525

2626
All skills and agents in this directory are for **contributors developing DataDesigner** — not for end users building datasets.
2727

28-
The usage skill for building datasets with DataDesigner lives separately at [`skills/data-designer/`](../skills/data-designer/). For product documentation, see the [docs site](https://nvidia-nemo.github.io/DataDesigner/).
28+
The usage skill for building datasets with DataDesigner lives separately at [`skills/data-designer/`](../skills/data-designer/). For product documentation, see the [docs site](https://docs.nvidia.com/nemo/datadesigner/).

.agents/agents/docs-searcher.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
---
22
name: docs-searcher
3-
description: Search local documentation in the docs/ folder for content related to a topic. Use this agent when the user wants to find documentation about a specific feature, concept, or usage pattern. Proactively use this when answering questions that might be covered in the project documentation.
3+
description: Search local Fern documentation for content related to a topic. Use this agent when the user wants to find documentation about a specific feature, concept, or usage pattern. Proactively use this when answering questions that might be covered in the project documentation.
44
tools: Glob, Grep, Read
55
model: haiku
66
permissionMode: bypassPermissions
77
---
88

99
# Documentation Search Agent
1010

11-
You are a documentation search specialist. Your role is to efficiently search the local `docs/` folder for content relevant to a given topic.
11+
You are a documentation search specialist. Your role is to efficiently search the local Fern docs under `fern/versions/latest/pages/` for content relevant to a given topic.
1212

1313
## Instructions
1414

1515
When given a search topic, perform the following searches:
1616

17-
1. **Find all documentation files** in the docs/ folder:
17+
1. **Find all documentation files** in the Fern pages folder:
1818
```
19-
Glob pattern: "docs/**/*.md"
19+
Glob pattern: "fern/versions/latest/pages/**/*.{md,mdx}"
2020
```
2121

2222
2. **Search for topic keywords** across all markdown files:
2323
```
24-
Grep pattern: "<topic keywords>" in path: "docs/"
24+
Grep pattern: "<topic keywords>" in path: "fern/versions/latest/pages/"
2525
```
2626
- Try multiple variations of the search terms (singular/plural, related terms)
2727
- Use case-insensitive search (`-i: true`)
@@ -44,12 +44,12 @@ When given a search topic, perform the following searches:
4444

4545
### Relevant Documentation
4646

47-
- **[docs/path/to/file.md](docs/path/to/file.md)**
47+
- **[fern/versions/latest/pages/path/to/file.mdx](fern/versions/latest/pages/path/to/file.mdx)**
4848
> Brief excerpt showing relevant content...
4949
5050
Explanation of why this is relevant to the search topic.
5151

52-
- **[docs/another/file.md](docs/another/file.md)**
52+
- **[fern/versions/latest/pages/another/file.mdx](fern/versions/latest/pages/another/file.mdx)**
5353
> Another relevant excerpt...
5454
5555
Explanation of relevance.
@@ -63,8 +63,8 @@ Brief summary of what was found and any recommendations for the user.
6363
- Only include results that are actually relevant to the search topic
6464
- If no relevant documentation is found, clearly state that
6565
- Keep excerpts concise but include enough context to be useful
66-
- Prioritize user guides, concepts, tutorials, and recipes according to the user's task
67-
- If the docs/ folder doesn't exist or is empty, report that clearly
66+
- Prioritize user guides, concepts, tutorials, recipes, and examples according to the user's task
67+
- If `fern/versions/latest/pages/` doesn't exist or is empty, report that clearly
6868

6969
## Search Strategy
7070

.agents/recipes/_fix-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ If the top-ranked candidate fails the bar, try the next. If none of the top
3939

4040
| Suite | Paths the recipe MAY modify |
4141
|-------|-----------------------------|
42-
| docs-and-references | `architecture/**`, `docs/**`, `README.md`, `CONTRIBUTING.md`, `DEVELOPMENT.md`, `STYLEGUIDE.md`, `packages/*/src/**/*.py` (docstring-only edits) |
42+
| docs-and-references | `architecture/**`, `fern/versions/latest/pages/**`, `README.md`, `CONTRIBUTING.md`, `DEVELOPMENT.md`, `STYLEGUIDE.md`, `packages/*/src/**/*.py` (docstring-only edits) |
4343
| dependencies | `packages/*/pyproject.toml` |
4444
| structure | `packages/*/src/**/*.py` |
4545
| code-quality | `packages/*/src/**/*.py` |

.agents/recipes/docs-and-references/recipe.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ interface package is what users see first.
7777
Check links in these locations:
7878
- `README.md` - all relative links and URLs
7979
- `architecture/*.md` - cross-references to other architecture docs and code
80-
- `docs/` - MkDocs content links, code references, cross-page links
80+
- `fern/versions/latest/pages/` - Fern content links, code references, cross-page links
8181
- `CONTRIBUTING.md`, `DEVELOPMENT.md`, `STYLEGUIDE.md` - relative links
8282

8383
Use targeted link extraction and inspect at most 10 candidate links. Prefer
@@ -103,23 +103,23 @@ ls architecture/
103103

104104
### 4. Docs site content accuracy
105105

106-
The MkDocs site under `docs/` is the primary user-facing documentation.
106+
The Fern site under `fern/versions/latest/pages/` is the primary user-facing documentation.
107107
Review for accuracy against the current code:
108108

109-
**Concepts pages** (`docs/concepts/`):
109+
**Concepts pages** (`fern/versions/latest/pages/concepts/`):
110110
- Do code examples use correct imports, class names, and method signatures?
111111
Check against actual source - e.g., verify `DataDesigner.create()`,
112112
`DataDesigner.preview()`, builder patterns match the real API.
113113
- Are there documented config options or column types that have been removed
114114
or renamed?
115115
- Are new features or column types missing from the docs?
116116

117-
**Recipes** (`docs/recipes/`):
117+
**Recipes** (`fern/versions/latest/pages/recipes/`):
118118
- Do step-by-step instructions reference correct file paths, class names,
119119
and CLI commands? Run `grep` for class names mentioned in recipe docs and
120120
verify they resolve in the source.
121121

122-
**Dev notes** (`docs/devnotes/posts/`):
122+
**Dev notes** (`fern/versions/latest/pages/devnotes/posts/`):
123123
- Dev notes describe implementation details that may have changed. Spot-check
124124
the most recent 3-5 posts for references to functions, classes, or
125125
architecture that have since been modified.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ description: >
1212

1313
Unified skill for adding, updating, moving, and removing pages on the NeMo Data Designer Fern docs site.
1414

15-
Current URL: **`datadesigner.docs.buildwithfern.com/nemo/datadesigner`** (see `instances` in [`fern/docs.yml`](../../../fern/docs.yml)). Source of truth for everything user-facing is `fern/`.
15+
Current URL: **`docs.nvidia.com/nemo/datadesigner`** (see `instances` in [`fern/docs.yml`](../../../fern/docs.yml)). Source of truth for everything user-facing is `fern/`.
1616

1717
## Scope Rule
1818

19-
**ALL doc edits happen under `fern/`.** The legacy `docs/` directory is the original MkDocs source. `docs/notebook_source/*.py` remains canonical for notebook code, but **do not add new top-level prose pages under `docs/`**. Concept pages, recipes, plugins, and Dev Notes prose live under `fern/versions/latest/pages/`.
19+
**ALL doc prose edits happen under `fern/`.** The remaining `docs/` directory is only for notebook source, generated Colab notebooks, docs scripts, and downloadable recipe scripts. `docs/notebook_source/*.py` remains canonical for notebook code. Concept pages, recipes, plugins, and Dev Notes prose live under `fern/versions/latest/pages/`.
2020

2121
## Versioning Model
2222

@@ -43,7 +43,7 @@ fern/
4343
├── fern.config.json ← organization + fern-api version pin
4444
├── main.css ← bundled NVIDIA theme CSS
4545
├── assets/ ← logos, favicon, recipe assets, devnote post images (shared)
46-
├── images/ ← /images/* references from MDX (mirrors docs/images/)
46+
├── images/ ← /images/* references from MDX
4747
├── styles/ ← per-component CSS (notebook-viewer, authors, metrics-table, …)
4848
├── components/ ← React/JSX MDX components
4949
│ ├── NotebookViewer.tsx ← renders converted .ipynb cells with outputs
@@ -434,7 +434,7 @@ git commit -s -m "docs: <add|update|remove> <page-title>"
434434

435435
DCO sign-off (`-s`) is required by CONTRIBUTING. Use `docs:` prefix (matches recent commit history). Subject line ≤ 50 chars (hard limit 72).
436436

437-
When the team adds a Fern preview workflow (modeled after Gym's `fern-docs-preview-comment.yml`), PRs touching `fern/**` will get an automatic preview URL posted as a comment. Until that lands, share local dev-server screenshots in PR descriptions.
437+
PRs touching Fern docs inputs get an automatic Fern preview URL posted as a comment. Fork PRs still run checks, but hosted preview publishing is skipped because it requires deployment secrets.
438438

439439
## Cutting a New Version Train
440440

@@ -461,4 +461,4 @@ Do not copy page trees by hand on `main`. The release workflow copies `latest/pa
461461

462462
- Editing Python source under `packages/` — that's a code change, not a docs change.
463463
- Adding a notebook tutorial's *code*: edit `docs/notebook_source/<name>.py`, not the converted `.ipynb` or the wrapper MDX.
464-
- Editing dev note *prose*: edit the migrated MDX under `fern/versions/latest/pages/devnotes/posts/<name>.mdx`. (The original `docs/devnotes/posts/<name>.md` is no longer the source of truth — Fern is.)
464+
- Editing dev note *prose*: edit the MDX under `fern/versions/latest/pages/devnotes/posts/<name>.mdx`.

.agents/skills/review-code/SKILL.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Read the following files at the repository root to load the project's standards
9797
**Documentation sources (load when the changeset touches matching areas):**
9898

9999
- **`architecture/*.md`** — subsystem maps aligned with `packages/` (e.g. `engine/mcp/``architecture/mcp.md`). Use to verify the PR does not leave recorded architecture false relative to new behavior.
100-
- **`docs/`** — published user-facing documentation. Cross-check when public API, CLI behavior, or config surface changes would affect what readers are told.
100+
- **`fern/versions/latest/pages/`** — published user-facing documentation. Cross-check when public API, CLI behavior, or config surface changes would affect what readers are told.
101101

102102
Use these guidelines as the baseline for the entire review. Project-specific rules take precedence over general best practices.
103103

@@ -181,14 +181,14 @@ Re-read the changed files with a focus on **structure and design of the new/modi
181181

182182
**Documentation alignment (same pass — scoped, not a full docs audit):**
183183

184-
When **code** under `packages/` changes behavior, structure, or public contracts in a way that a maintainer would reasonably describe in `architecture/` or `docs/`:
184+
When **code** under `packages/` changes behavior, structure, or public contracts in a way that a maintainer would reasonably describe in `architecture/` or Fern docs:
185185

186-
1. Identify the closest **`architecture/<topic>.md`** (and any obvious `docs/` pages) for that subsystem.
186+
1. Identify the closest **`architecture/<topic>.md`** (and any obvious `fern/versions/latest/pages/` pages) for that subsystem.
187187
2. If the PR **also edits** those docs, sanity-check that the edits match the code.
188-
3. If the PR **does not** edit docs but the change **contradicts** what `architecture/` or `docs/` currently asserts, flag it (**Warnings** if contributors rely on that text; **Suggestions** if impact is narrow). Suggest updating the same PR or an explicit follow-up issue.
188+
3. If the PR **does not** edit docs but the change **contradicts** what `architecture/` or Fern docs currently assert, flag it (**Warnings** if contributors rely on that text; **Suggestions** if impact is narrow). Suggest updating the same PR or an explicit follow-up issue.
189189
4. **Skip** this check for pure refactors with no observable behavior change, typo-only PRs, or changes already limited to documentation.
190190

191-
The local **`search-docs`** skill can help locate `docs/` pages by topic when the right file is not obvious.
191+
The local **`search-docs`** skill can help locate Fern docs pages by topic when the right file is not obvious.
192192

193193
### Pass 3: Standards, Testing & Polish
194194

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
name: search-docs
3-
description: Search local documentation in the docs/ folder for content related to a topic
3+
description: Search local Fern documentation for content related to a topic
44
argument-hint: <search-topic>
55
metadata:
66
internal: true
77
---
88

99
# Documentation Search
1010

11-
Use the `docs-searcher` subagent to search local documentation for content related to: **$ARGUMENTS**
11+
Use the `docs-searcher` subagent to search local Fern documentation for content related to: **$ARGUMENTS**
1212

1313
Call the Task tool with:
1414
- `subagent_type: "docs-searcher"`

.github/scripts/patch-devnotes-nav.py

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

.github/workflows/build-docs.yml

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

0 commit comments

Comments
 (0)