docs: comprehensive README with release workflow and CI explanation#211
Merged
gtrivedi88 merged 1 commit intoMay 13, 2026
Merged
Conversation
Rewrite docs/README.md to fully document: - Cutting a new release (display_version, auto-detection) - How publishing works with detailed job-by-job explanation - How the check job gates build/deploy via GITHUB_OUTPUT - That docs are built from the release branch directly (no docs branch or tag) - GitHub Pages configuration requirements 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
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
Rewrites
docs/README.mdto fully document the publishing workflow. Addresses questions like "does the build use docs from the release branch or from a tag?" and "how does the check job gate the build?"What's new
display_version, no CI changes neededcheckwrites to$GITHUB_OUTPUTandbuildreads it vianeeds.check.outputs.is-latestdocsbranch or tag involvedtoolbar.hbsWhat's removed
Test plan
🤖 Generated with Claude Code