Nest publish in CI, simplify assemble injection, add diataxis docs#7
Merged
Conversation
Three changes from todo.md, refined over several review passes:
1. Publish visible on internal PRs. publish.yml -> reusable _publish.yml
(workflow_call + workflow_dispatch); ci.yml nests it as a `publish` job for
internal events only (canonical-repo + non-fork guard lives in ci.yml), so the
deploy shows as a PR/commit check. Fork PRs get a warning step in _docs.yml's
build job linking the manual opt-in. Because publish runs inside the build's own
run, the action downloads this run's `docs` artifact and assemble.sh unzips +
stages it via `artifact-version-name`, skipping the re-gather of that version.
Operator: the github-pages environment must allow the deploying refs
(recommend "Deployment branches and tags" -> No restriction).
2. Rename the version concept "token" -> "version-name" throughout (avoids
confusion with GitHub auth tokens).
3. Docs reworked into a Diataxis tree mirroring python-copier-template-example:
README selling-points are {include}d into index.md (+ a 4-card grid); category
landing pages; tutorial / how-to (migrate, contribute) / explanation
(architecture, folding in the deleted DESIGN.md) / reference (directive, action).
Dev commands move to .github/CONTRIBUTING.md; the tutorial {literalinclude}s the
generic _docs.yml build so it can't drift. Deferred release-layer cache tracked
as issue #6.
Co-Authored-By: Claude Opus 4.8 <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
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.
Three changes from todo.md, refined over several review passes:
Publish visible on internal PRs. publish.yml -> reusable _publish.yml (workflow_call + workflow_dispatch); ci.yml nests it as a
publishjob for internal events only (canonical-repo + non-fork guard lives in ci.yml), so the deploy shows as a PR/commit check. Fork PRs get a warning step in _docs.yml's build job linking the manual opt-in. Because publish runs inside the build's own run, the action downloads this run'sdocsartifact and assemble.sh unzips + stages it viaartifact-version-name, skipping the re-gather of that version. Operator: the github-pages environment must allow the deploying refs (recommend "Deployment branches and tags" -> No restriction).Rename the version concept "token" -> "version-name" throughout (avoids confusion with GitHub auth tokens).
Docs reworked into a Diataxis tree mirroring python-copier-template-example: README selling-points are {include}d into index.md (+ a 4-card grid); category landing pages; tutorial / how-to (migrate, contribute) / explanation (architecture, folding in the deleted DESIGN.md) / reference (directive, action). Dev commands move to .github/CONTRIBUTING.md; the tutorial {literalinclude}s the generic _docs.yml build so it can't drift. Deferred release-layer cache tracked as issue Release-layer cache for
assemble(deferred optimisation) #6.