Promote reference docs pipeline out of pilot - #94
Open
hey-august wants to merge 18 commits into
Open
Conversation
…op dead navbar.js code
…deploy (remove `mike`)
…ugust-20260714-promote-reference-to-production
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
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.
What this changes
Follow-up to #41, which added the API reference docs pipeline in its pilot configuration. This completes the promotion to production.
v*release tags (plus manualworkflow_dispatch) instead of on the pilot branch, so the docs regenerate on a version bump rather than on every push. Thanks to @jpsantosbh for raising this during review.mike-based versioning with a single unversioned site built viamkdocs gh-deploy.docs_dircomment and removal of dead code innavbar.js.Testing: validated end to end on my fork: dispatched the workflow from this branch and confirmed a green run (run link), a fresh
gh-pagesdeploy, and the rebuilt site at hey-august.github.io/signalwire-python, including pages for modules added since the pilot (signalwire.ai_chat).Checklist
No Python source or test changes in this PR; test items are N/A.
bash scripts/run-ci.shpasses locallymypycoverstests/)Does this change public API?
infrastructure change:
Changing something that goes on the wire?
If this alters an emitted shape, an enum value, or a parameter name, say where
you confirmed it — the generated types under
signalwire/**/*_generated.pyarederived from the engine's schemas and are the authority here.