Add ConformalForecast anchor to production docs navigation - #53
Open
nasaul wants to merge 1 commit into
Open
Conversation
The anchor must exist before the pipeline runs: merge_navigation looks it up by name and returns early if absent, so without it the pages copy in with nothing linking to them. groups is left empty on purpose — merge_docs.py fills it at build time from conformalforecast's own docs.json. merge_docs.py is updated here too because this branch's copy is the one the workflow executes (it checks out Nixtla/docs at this ref and runs merge_docs.py from the checkout).
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the
ConformalForecastanchor to the production navigation, ahead of wiring conformalforecast into the build pipeline.Merge order: this PR has no dependencies — merge it alongside #52, before the pipeline PR.
merge_navigationlooks the anchor up by name and returns early when it is absent, so the anchor has to exist before the pipeline runs. Merge the pipeline PR first and the pages get copied in with nothing linking to them.groupsis left empty on purpose —merge_docs.pyfills it at build time from conformalforecast’s owndocs.json.merge_docs.pyis updated here too, because this branch’s copy is the one that actually executes: the workflow checks outNixtla/docsat this ref and runsmerge_docs.pyfrom the checkout. The copy onmainis kept in sync but never runs.Same shape as #44, which did this for SynForecast.
Verification
The equivalent merge was exercised end to end on the preview side (see #52): 5 groups / 22 pages, every nav entry resolving to a real file, no other anchor disturbed. This branch carries the identical 5-line anchor insert and the identical
merge_docs.pychange.Note on production readiness
The anchor is harmless to merge now, but production will not render ConformalForecast pages until
Nixtla/conformalforecastactually has adocsbranch. Nothing has published to it yet — it needs a release, or abuild-docs.yamlworkflow_dispatchwithdeploy_target=production. Until then the anchor sits empty on production, and the pipeline PR’s production clone step will fail.Blocks
add-conformalforecast-to-pipeline) — must not merge until this one lands.