Skip to content

Commit b6de38d

Browse files
docs: remove docs code reference (#674)
1 parent 2a487cd commit b6de38d

86 files changed

Lines changed: 79 additions & 1690 deletions

Some content is hidden

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

.agents/agents/docs-searcher.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ 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 and examples over API reference when both exist
66+
- Prioritize user guides, concepts, tutorials, and recipes according to the user's task
6767
- If the docs/ folder doesn't exist or is empty, report that clearly
6868

6969
## Search Strategy

.agents/recipes/code-quality/recipe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Examples of things to test (pick 2-3 per run, and invent new ones):
152152
- Column names with special characters or very long strings
153153
- Recently changed validators (check `git log --oneline -10 -- packages/*/src/data_designer/config/`)
154154

155-
**API reference:**
155+
**Useful imports:**
156156

157157
```python
158158
from data_designer.config.config_builder import DataDesignerConfigBuilder

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,6 @@ Review for accuracy against the current code:
101101
the most recent 3-5 posts for references to functions, classes, or
102102
architecture that have since been modified.
103103

104-
**Code reference** (`docs/code_reference/`):
105-
- Check that autodoc module paths point to modules that still exist.
106-
107104
**Prioritize by risk of drift**: pages with the most code symbols referenced
108105
are most likely to be stale. Don't read every page - sample 5-10 high-value
109106
pages and flag patterns.

.agents/recipes/test-health/recipe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ without at least one provider configured. Stick to config-layer checks
208208
(`DataDesignerConfigBuilder.build()`, column type resolution) which do
209209
not require providers.
210210

211-
**API reference** for writing checks:
211+
**Useful imports** for writing checks:
212212

213213
```python
214214
from data_designer.config.config_builder import DataDesignerConfigBuilder

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

Lines changed: 4 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ description: >
44
Maintain the NeMo Data Designer Fern docs site under fern/. Use for any
55
documentation change. Triggered by: "edit docs", "add doc page", "update
66
docs", "rename page", "fix broken link", "add redirect", "preview docs",
7-
"publish docs", "regenerate notebooks", "update dev note", "add API
8-
reference", any request that touches `fern/`.
7+
"publish docs", "regenerate notebooks", "update dev note", any request
8+
that touches `fern/`.
99
---
1010

1111
# Data Designer Docs Maintenance
@@ -16,7 +16,7 @@ Current URL: **`datadesigner.docs.buildwithfern.com/nemo/datadesigner`** (see `i
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, code reference, and Dev Notes prose live under `fern/versions/latest/pages/`.
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/`.
2020

2121
## Versioning Model
2222

@@ -39,7 +39,7 @@ For future Fern-native releases, do not copy page trees by hand on `main`. The r
3939
```
4040
fern/
4141
├── README.md ← maintainer cheat sheet
42-
├── docs.yml ← title, theme, versions:, libraries:, redirects, custom-domain
42+
├── docs.yml ← title, theme, versions:, redirects, custom-domain
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)
@@ -56,7 +56,6 @@ fern/
5656
│ └── devnotes/ ← .authors.yml, authors-data.ts, per-post trajectory data
5757
├── scripts/
5858
│ └── ipynb-to-fern-json.py ← .ipynb → fern/components/notebooks/*.{json,ts}
59-
├── code-reference/ ← gitignored; populated by `fern docs md generate`
6059
└── versions/
6160
├── latest.yml ← authoring navigation tree
6261
└── latest/pages/ ← authoring MDX content
@@ -401,47 +400,6 @@ import notebook from "@/components/notebooks/1-the-basics";
401400

402401
The converter (`fern/scripts/ipynb-to-fern-json.py`) **auto-strips the leading Colab badge cell** — `<NotebookViewer>` renders its own banner from the `colabUrl` prop. Don't manually re-add it.
403402

404-
## Python API Reference (`libraries:`)
405-
406-
`docs.yml` keeps a Fern-native `libraries:` block for the config package. Local generation uses `py2fern` through `make generate-fern-api-reference` and writes multiple gitignored trees under `fern/code-reference/`:
407-
408-
- `data-designer/` for `data_designer.config`
409-
- `interface/` for `data_designer.interface`
410-
- `engine/seed-readers/`
411-
- `engine/processors/`
412-
- `engine/mcp/`
413-
- `engine/column-generators/`
414-
415-
To populate locally:
416-
417-
```bash
418-
make generate-fern-api-reference
419-
```
420-
421-
This does not require Fern auth. Re-run when the upstream Python source changes. If you need to compare with Fern's native generator, use `make generate-fern-api-reference-native` with Fern auth.
422-
423-
The generated trees are wired into `versions/latest.yml` under `Code Reference`:
424-
425-
- `Config` contains prose pages plus `Config API` from `../code-reference/data-designer/data_designer/config`
426-
- `Interface` contains prose pages plus `Interface API` from `../code-reference/interface/data_designer/interface`
427-
- `Engine Extension API` contains prose pages plus the seed reader, processor, MCP runtime, and column generator API folders
428-
429-
There is no `Topic Overviews` section. Prose reference pages live beside the generated folders under `fern/versions/latest/pages/code_reference/`.
430-
431-
To add another generated package, update the `generate-fern-api-reference` target and add the matching `folder:` entry under the right `Code Reference` section. Only add a `libraries:` entry when Fern's native generator should know about that source:
432-
433-
```yaml
434-
libraries:
435-
data-designer:
436-
input:
437-
git: https://github.com/NVIDIA-NeMo/DataDesigner
438-
subpath: packages/data-designer-config/src/data_designer/config
439-
output: { path: ./code-reference/data-designer }
440-
lang: python
441-
```
442-
443-
Pyright needs a regular Python package (with `__init__.py`). The `data_designer` namespace itself is PEP 420 (no `__init__.py`), so always point at a sub-package one level deeper.
444-
445403
## MDX Gotchas (the ones that bit during migration)
446404

447405
| Pattern | Problem | Fix |
@@ -467,14 +425,6 @@ fern docs dev # localhost:3000 hot-reload preview
467425

468426
`fern check` must pass before commit. The local broken-link checker has known false positives — it computes URLs from file paths instead of from slugified nav titles, so cross-section absolute links sometimes flag incorrectly. Spot-check by clicking through the dev server.
469427

470-
To generate the API reference for local preview:
471-
472-
```bash
473-
make generate-fern-api-reference # py2fern; populates fern/code-reference/ (gitignored)
474-
```
475-
476-
If the "Python API" sidebar folder is empty, you forgot this step.
477-
478428
## Commit & Preview
479429

480430
```bash

.github/workflows/docs-preview.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,7 @@ jobs:
8888
cd "$FERN_PREVIEW_ROOT"
8989
make check-fern-docs \
9090
DOCS_PYTHON="$GITHUB_WORKSPACE/.venv/bin/python" \
91-
DOCS_JUPYTEXT="$GITHUB_WORKSPACE/.venv/bin/jupytext" \
92-
DOCS_PY2FERN="$GITHUB_WORKSPACE/.venv/bin/py2fern"
91+
DOCS_JUPYTEXT="$GITHUB_WORKSPACE/.venv/bin/jupytext"
9392
9493
- name: Skip hosted previews for fork PRs
9594
if: github.event.pull_request.head.repo.full_name != github.repository

.gitignore

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,6 @@ packages/data-designer/README.md
115115
# Claude worktrees
116116
.claude/worktrees/
117117

118-
# Fern libraries output — generated by `fern docs md generate` from `libraries:` in fern/docs.yml.
119-
# Regenerate locally (no token needed) or in CI before publishing.
120-
fern/code-reference/
121-
122118
# Fern notebook output - generated by `make generate-fern-notebooks`.
123119
fern/components/notebooks/*.json
124120
fern/components/notebooks/*.ts

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Data Designer is migrating from MkDocs to Fern over several releases. Until the
7979
- Use `make serve-docs-locally` to preview the legacy MkDocs site.
8080
- Use `make check-fern-docs` to regenerate local Fern artifacts and validate the Fern site.
8181
- Fern release publishing snapshots versioned docs into the CI-managed `docs-website` branch automatically.
82-
- Do not commit generated Fern API reference or notebook artifacts.
82+
- Do not commit generated notebook artifacts.
8383

8484
---
8585

Makefile

Lines changed: 2 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,6 @@ help:
8080
@echo " generate-colab-notebooks - Generate Colab-compatible notebooks"
8181
@echo " generate-fern-notebooks - Convert docs/notebook_source/*.py → fern/components/notebooks/{json,ts}"
8282
@echo " generate-fern-notebooks-with-outputs - Full pipeline: execute notebooks (needs API key), colabify, convert to Fern"
83-
@echo " generate-fern-api-reference - Generate local Fern API reference with py2fern"
84-
@echo " generate-fern-api-reference-native - Generate Fern API reference with Fern CLI (requires auth)"
8583
@echo " install-docs-deps - Install docs and notebook dependencies"
8684
@echo " prepare-fern-release VERSION=X.Y.Z - Add or refresh Fern version files for release preview"
8785
@echo " check-fern-release-version VERSION=X.Y.Z - Verify Fern has a version entry for release publishing"
@@ -474,15 +472,6 @@ DOCS_PYTHON_VERSION ?= 3.13
474472
DOCS_PYTHON ?= .venv/bin/python
475473
DOCS_JUPYTEXT ?= .venv/bin/jupytext
476474
DOCS_MKDOCS ?= .venv/bin/mkdocs
477-
DOCS_PY2FERN ?= .venv/bin/py2fern
478-
FERN_API_REFERENCE_OUTPUT ?= fern/code-reference
479-
FERN_API_REFERENCE_CONFIG_OUTPUT ?= $(FERN_API_REFERENCE_OUTPUT)/data-designer
480-
FERN_API_REFERENCE_CONFIG_SOURCE ?= packages/data-designer-config/src/data_designer/config
481-
FERN_API_REFERENCE_INTERFACE_SOURCE ?= packages/data-designer/src/data_designer/interface
482-
FERN_API_REFERENCE_ENGINE_COLUMN_GENERATORS_SOURCE ?= packages/data-designer-engine/src/data_designer/engine/column_generators/generators/base.py
483-
FERN_API_REFERENCE_ENGINE_MCP_SOURCE ?= packages/data-designer-engine/src/data_designer/engine/mcp
484-
FERN_API_REFERENCE_ENGINE_PROCESSORS_SOURCE ?= packages/data-designer-engine/src/data_designer/engine/processing/processors
485-
FERN_API_REFERENCE_ENGINE_SEED_READERS_SOURCE ?= packages/data-designer-engine/src/data_designer/engine/resources/seed_reader.py
486475
FERN_VERSION ?= $(shell jq -r .version fern/fern.config.json)
487476
FERN ?= npx -y fern-api@$(FERN_VERSION)
488477

@@ -501,21 +490,6 @@ serve-docs-locally:
501490
@echo "📝 Building and serving docs (Python $(DOCS_PYTHON_VERSION))..."
502491
$(DOCS_MKDOCS) serve --livereload
503492

504-
generate-fern-api-reference:
505-
@echo "📚 Generating Fern API reference with py2fern ($(DOCS_PY2FERN))..."
506-
@rm -rf $(FERN_API_REFERENCE_OUTPUT)
507-
$(DOCS_PY2FERN) write $(FERN_API_REFERENCE_CONFIG_SOURCE) --module data_designer.config --output $(FERN_API_REFERENCE_CONFIG_OUTPUT) --clean
508-
$(DOCS_PY2FERN) write $(FERN_API_REFERENCE_INTERFACE_SOURCE) --module data_designer.interface --output $(FERN_API_REFERENCE_OUTPUT)/interface --clean
509-
$(DOCS_PY2FERN) write $(FERN_API_REFERENCE_ENGINE_COLUMN_GENERATORS_SOURCE) --module data_designer.engine.column_generators.generators.base --output $(FERN_API_REFERENCE_OUTPUT)/engine/column-generators --clean
510-
$(DOCS_PY2FERN) write $(FERN_API_REFERENCE_ENGINE_MCP_SOURCE) --module data_designer.engine.mcp --output $(FERN_API_REFERENCE_OUTPUT)/engine/mcp --clean
511-
$(DOCS_PY2FERN) write $(FERN_API_REFERENCE_ENGINE_PROCESSORS_SOURCE) --module data_designer.engine.processing.processors --output $(FERN_API_REFERENCE_OUTPUT)/engine/processors --clean
512-
$(DOCS_PY2FERN) write $(FERN_API_REFERENCE_ENGINE_SEED_READERS_SOURCE) --module data_designer.engine.resources.seed_reader --output $(FERN_API_REFERENCE_OUTPUT)/engine/seed-readers --clean
513-
$(DOCS_PYTHON) fern/scripts/normalize-py2fern-indexes.py $(FERN_API_REFERENCE_OUTPUT)
514-
515-
generate-fern-api-reference-native:
516-
@echo "📚 Generating Fern API reference with Fern CLI..."
517-
cd fern && $(FERN) docs md generate
518-
519493
prepare-fern-release:
520494
ifndef VERSION
521495
$(error VERSION is required, e.g. make prepare-fern-release VERSION=0.5.10)
@@ -528,7 +502,7 @@ ifndef VERSION
528502
endif
529503
$(DOCS_PYTHON) fern/scripts/fern-release-version.py check --version $(VERSION) $(if $(REQUIRE_LATEST),--require-latest-matches-release,)
530504

531-
prepare-fern-docs: generate-fern-api-reference generate-fern-notebooks
505+
prepare-fern-docs: generate-fern-notebooks
532506
@echo "✅ Fern local artifacts ready"
533507

534508
check-fern-docs: prepare-fern-docs
@@ -759,7 +733,7 @@ clean-test-coverage:
759733
coverage coverage-config coverage-engine coverage-interface \
760734
format format-check format-check-config format-check-engine format-check-interface \
761735
format-config format-engine format-interface \
762-
generate-colab-notebooks generate-fern-api-reference generate-fern-api-reference-native generate-fern-notebooks generate-fern-notebooks-with-outputs help \
736+
generate-colab-notebooks generate-fern-notebooks generate-fern-notebooks-with-outputs help \
763737
install install-dev install-dev-notebooks install-dev-recipes install-docs-deps \
764738
lint lint-config lint-engine lint-fix lint-fix-config lint-fix-engine lint-fix-interface lint-interface \
765739
perf-import perf-import-runtime prepare-fern-docs prepare-fern-release publish serve-docs-locally serve-fern-docs-locally show-versions \

docs/code_reference/config/analysis.md

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

0 commit comments

Comments
 (0)