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
"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/`.
9
9
---
10
10
11
11
# Data Designer Docs Maintenance
@@ -16,7 +16,7 @@ Current URL: **`datadesigner.docs.buildwithfern.com/nemo/datadesigner`** (see `i
16
16
17
17
## Scope Rule
18
18
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/`.
20
20
21
21
## Versioning Model
22
22
@@ -39,7 +39,7 @@ For future Fern-native releases, do not copy page trees by hand on `main`. The r
├── code-reference/ ← gitignored; populated by `fern docs md generate`
60
59
└── versions/
61
60
├── latest.yml ← authoring navigation tree
62
61
└── latest/pages/ ← authoring MDX content
@@ -401,47 +400,6 @@ import notebook from "@/components/notebooks/1-the-basics";
401
400
402
401
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.
403
402
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:
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
-
445
403
## MDX Gotchas (the ones that bit during migration)
`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.
469
427
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.
0 commit comments