docs: publish devnote figure component#721
Conversation
Signed-off-by: Johnny Greco <jogreco@nvidia.com>
Greptile SummaryThis PR fixes MDX pages that import
|
| Filename | Overview |
|---|---|
| .github/workflows/publish-fern-devnotes.yml | Adds three new path triggers: the workflow file itself, fern/components/Figure.tsx, and fern/scripts/fern-published-branch.py — all logically necessary to ensure publishing reruns when support infrastructure changes. |
| fern/scripts/fern-published-branch.py | Adds fern/components/Figure.tsx to FERN_DEVNOTE_SUPPORT_PATHS so it gets copied via copy_path during patch-devnotes, consistent with how every other component in the list is handled. |
| packages/data-designer/tests/docs/test_fern_published_branch.py | Seeds Figure.tsx in the test source fixture and asserts it is present in the published root after patch_devnotes, correctly covering the regression introduced by the missing component. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Push to main] -->|path filter matches| B[publish-fern-devnotes.yml]
B --> C[Checkout workflow / source / website]
C --> D[patch-devnotes]
D --> E[sync_fern_root_config]
D --> F[copy FERN_DEVNOTE_SUPPORT_PATHS]
F --> F1[fern/assets]
F --> F2[Authors.tsx]
F --> F3[BlogCard.tsx]
F --> F4[Figure.tsx new]
F --> F5[MetricsTable.tsx]
F --> F6[TrajectoryViewer.tsx]
F --> F7[fern/components/devnotes]
D --> G[rewrite devnotes nav block]
G --> H[Commit & push to docs-website]
H --> I[npx fern generate --docs]
Reviews (1): Last reviewed commit: "docs: publish devnote figure component" | Re-trigger Greptile
|
MkDocs preview: https://adeda8cf.dd-docs-preview.pages.dev Fern preview: https://nvidia-preview-pr-721.docs.buildwithfern.com/nemo/datadesigner
|
Review: PR #721 — docs: publish devnote figure componentSummarySmall, surgical fix (8 additions, 0 deletions across 3 files) that repairs the Fern Dev Notes publish path so MDX pages importing the shared Three concrete changes:
FindingsCorrectness — looks good
Test coverage — adequate
Style / conventions — clean
Risks — low
Nits (non-blocking)
VerdictApprove in spirit (no formal approval per CI policy). The PR is minimal, well-scoped, internally consistent, has a regression test that pins the new behavior, and addresses both the immediate symptom (missing component in published tree) and the meta-issue (path filter that wouldn't have re-triggered on the fix itself). Ready to merge once CI is green. |
📋 Summary
This PR fixes the Fern Dev Notes publish path so MDX pages that import the shared
Figurecomponent can render after being patched into thedocs-websitebranch. It also makes the Dev Notes publish workflow rerun when the support copier or figure component changes, so this repair can publish without waiting for an unrelated docs edit.🔗 Related Issue
N/A
🔄 Changes
Figure.tsxas part of the Dev Notes support files used byfern-published-branch.py.publish-fern-devnotes.ymlpath filters so changes to the workflow, publish script, orFigure.tsxtrigger Dev Notes publishing.test_fern_published_branch.pyconfirming the figure component is copied into the published tree.🧪 Testing
make testpasses (not run; focused docs validation below)uv run --group dev pytest packages/data-designer/tests/docs/test_fern_published_branch.py -quv run ruff format --check fern/scripts/fern-published-branch.py packages/data-designer/tests/docs/test_fern_published_branch.pyuv run ruff check fern/scripts/fern-published-branch.py packages/data-designer/tests/docs/test_fern_published_branch.pynpx -y fern-api@5.41.1 check✅ Checklist