Merged
Conversation
Add nav_generator.py that builds the mkdocs nav section automatically from the workflow and action configs, keeping entries sorted alphabetically and using nav_title overrides where needed. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Deploy docs to a per-branch Mike version on workflow_dispatch, and automatically remove the preview when the branch is deleted. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace slashes with dashes in branch names since Mike does not accept slashes in version identifiers (e.g. feature/foo becomes feature-foo). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
2 participants
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.
Summary
Auto-generate the mkdocs nav section from workflow/action metadata instead of maintaining it by hand, and enable per-branch preview deploys that are automatically cleaned up when the branch is deleted.
Changes
nav_generator.pythat builds the nav tree from the config registry, with title derivation, acronym handling, and duplicate disambiguationgenerate-docs.pyso the nav section inmkdocs.ymlstays in sync with registered workflows/actionsnav_titleoverride support inconfig.pyfor entries that need custom sidebar namesworkflow_dispatchcleanup-previewjob removes the branch preview from gh-pages on branch deletionDiagram
View diagram
flowchart TD A[Event Trigger] --> B{Event type?} B -->|push / workflow_dispatch| C[deploy job] B -->|delete| D[cleanup-preview job] C --> E{Ref type?} E -->|tag| F["mike deploy v1.0 + alias latest"] E -->|branch| G["mike deploy branch-name\n(slashes to dashes)"] D --> H{branch != main?} H -->|yes| I["mike delete branch-name"] H -->|no| J[skip]