Document GitHub docs workflow - #7
Merged
Merged
Conversation
Collaborator
Author
|
Independent review complete: documentation/adoption reviewer and validation/operations reviewer both returned clean. PR check on head c78098b passed Validate documentation and skipped Deploy documentation for the pull_request event as expected. |
This was referenced Jun 24, 2026
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.
Summary
Updates the README documentation workflow to describe the GitHub-native docs path introduced by #6. The README now distinguishes local preview from the canonical clean build script, and states that GitHub Actions validates every pull request and
mainpush while deploying GitHub Pages only frommainafter validation.Closes #4
Validation
rg -n "gitlab|GitLab|\.gitlab-ci|gitlab\.io" README.md docs zensical.toml scripts .github || true-> no matchespython3 scripts/render-dev-notes.py-> passedpython3 -m py_compile scripts/render-dev-notes.py-> passedscripts/build-docs.sh-> passed; generatedsite/curl -fsS http://127.0.0.1:8000/againstpython3 -m http.server 8000 --bind 127.0.0.1 --directory site-> HTTP 200Risks
Low. This only updates repository-facing README guidance and does not change the generated docs site, build script, or workflow logic.
Reviewer Notes
Focus on whether the README accurately describes
.github/workflows/docs.yml, local preview, the canonical clean build, PR validation, andmainGitHub Pages deployment. Backward compatibility with GitLab CI was not required.