docs: document Fern docs publishing workflow#2015
Conversation
Greptile SummaryThis PR documents the Fern docs publishing workflow and adds the
|
| Filename | Overview |
|---|---|
| Makefile | Adds docs-fern-publish-public make target and FERN_PUBLIC_INSTANCE variable, mirroring the existing staging target. Adds the new target to .PHONY and the help output. |
| docs/LIVE_DOCS.mdx | Adds a "CI Publishing" section explaining the PR-preview, staging-on-merge, and manual public-publish workflow. No issues found. |
| CONTRIBUTING.md | Adds two new rows to the docs table for the staging and public publish targets, adds a CI-publishing paragraph, and fixes ordered-list formatting by indenting blockquotes so they don't break the numbered sequence (renumbering steps 6/7 to 5/6 accordingly). |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Open PR with docs changes] --> B{Same-repository branch?}
B -- Yes --> C[Fern check + publish PR preview]
B -- No fork --> D[Fern check only]
C --> E[PR merges into develop]
D --> E
E --> F[Auto-publish to Staging instance]
F --> G[Maintainer verifies staging]
G --> H[make docs-fern-publish-public]
H --> I[Published to Public instance]
Reviews (4): Last reviewed commit: "chore: address docs publishing review co..." | Re-trigger Greptile
|
Staged Fern docs preview: https://nvidia-preview-pr-2015.docs.buildwithfern.com/nemo/guardrails |
📝 WalkthroughWalkthroughThis PR adds documentation describing the Fern docs build workflow behavior across two files. It clarifies that documentation PRs trigger validation and preview publication, and that docs changes merged to ChangesFern Docs CI/Publishing Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
@tgasser-nv incorporated all feedback, merging. Thank you! |
Description
Document the Fern docs publishing workflow for documentation changes:
developpublish to the staging instance.make docs-fern-publish-publicpublishes the staged docs to the public Fern instance.Related Issue(s)
Verification
make -n docs-fern-publish-publicChecklist