fix(devnotes): include Figure component in Fern dev-notes publish alllowlist#722
fix(devnotes): include Figure component in Fern dev-notes publish alllowlist#7223mei wants to merge 1 commit into
Conversation
…owlist Signed-off-by: Yev Meyer <ymeyer@nvidia.com>
Greptile SummaryThis PR fixes a broken deploy for the Nemotron-Personas dev note by adding
|
| Filename | Overview |
|---|---|
| .github/workflows/publish-fern-devnotes.yml | Adds fern/components/Figure.tsx to the workflow trigger paths so future edits to the component re-trigger a republish — consistent with all other component entries. |
| fern/scripts/fern-published-branch.py | Adds fern/components/Figure.tsx to FERN_DEVNOTE_SUPPORT_PATHS so it is copied into the deploy branch during patch-devnotes; the file exists at HEAD and is imported by two dev note MDX pages. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Push to main] -->|paths trigger| B{publish-fern-devnotes workflow}
B --> C[Checkout source, workflow, website branches]
C --> D[patch-devnotes script]
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 ✅ added]
F --> F5[MetricsTable.tsx]
F --> F6[TrajectoryViewer.tsx]
F --> F7[fern/components/devnotes]
D --> G[extract + rewrite devnotes nav block]
G --> H[Commit & push to docs-website branch]
H --> I[fern generate --docs]
Reviews (1): Last reviewed commit: "fix(devnotes): include Figure component ..." | Re-trigger Greptile
|
MkDocs preview: https://5ad2a88e.dd-docs-preview.pages.dev Fern preview: https://nvidia-preview-pr-722.docs.buildwithfern.com/nemo/datadesigner
|
|
Closing in favor of #721 |
Review of PR #722Title: fix(devnotes): include Figure component in Fern dev-notes publish allowlist SummarySmall, targeted fix that adds
The Nemotron-Personas dev note from #611 imports FindingsCorrectness — ✅
Style / conventions — ✅
Test coverage —
|
📋 Summary
The Fern dev-notes publish workflow patches only an explicit allowlist of component files into the
docs-websitedeploy branch. The new<Figure>component shipped by the Nemotron-Personas dev note (#611) wasn't on that allowlist, so the deployed site fails to resolve the import and renders an MDX compile error (Could not resolve "../../../../../components/Figure") in place of the post. This PR addsfern/components/Figure.tsxto both the workflow trigger paths and theFERN_DEVNOTE_SUPPORT_PATHSlist used by the patch-devnotes script.🔗 Related Issue
Follow-up to #611 — without this fix, the Nemotron-Personas dev note renders as a compile error on the deployed Fern site.
🔄 Changes
fern/components/Figure.tsxto.github/workflows/publish-fern-devnotes.ymltrigger paths, so future edits to the component re-trigger a republish.fern/components/Figure.tsxtoFERN_DEVNOTE_SUPPORT_PATHSinfern/scripts/fern-published-branch.py, so the file is actually copied into thedocs-websitedeploy branch alongside the other dev-note kit components.🧪 Testing
fern checkpasses locally with the existing dev-note pages.fern/components/Figure.tsxis committed at HEAD and resolves locally; the gap was only on the deploy-branch copy step.make testpasses — N/A (docs-only fix, no Python changes).✅ Checklist
fix(devnotes): ...).