Repository navigation
README and documentation site: the two docs issues, verified against the source they describe - #46
Merged
Merged
Conversation
added 2 commits
August 16, 2026 11:08
RobeyBeswick
added a commit
that referenced
this pull request
Aug 18, 2026
README and documentation site: the two docs issues, verified against the source they describe
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.
The two documentation issues, built by the loop on the tree that finally has every module in it.
What's in it
docs/, a layout, CSS, and.github/workflows/pages.ymlto deploy itBoth were deliberately held back until the two parallel hosts were merged. A README is the most
cross-cutting thing in the backlog — it has to see
slices/andmetrics/at the same time — so theyran on one host against
mainat305ef70, never split.The part worth reading
Neither issue is only prose. #41 added
readme_test.goand #42 addeddocs_test.go, together 1.7k linesthat hold both documents to the source they describe:
```goblock is parsed, so a snippet that would not compile fails the build rather than thereader's afternoon;
archunit.Xand every method of a chain rooted there is resolved against this module's ownsyntax tree, read with
go/parserrather than reflection — reflection cannot see an uncalled methodor a field's name, and those are most of what a document names;
That is #41's own stated failure mode made unfailable: "a sibling port's README documents a slice API
that does not exist." It cannot happen here now without a red build.
Verification
Every job in
.github/workflows/ci.yml, run by hand on this exact tree, because GitHub Actions stillreports nothing on this repository — zero workflow runs, ever.
build—go build,go vet,go mod tidy -difftest—go test -race -shuffle=on -count=1 ./...dogfood— the architecture suitelint—config verify,fmt --diff,run ./...cross-build—windows/amd64,linux/386gofmt -l .clean.Two things need the repository owner
docs/and the deploy workflow are here, butGET /repos/.../pagesis a404 and Actions has never run, so nothing publishes until both are switched on. That is an admin
setting.
workflowscope. Documentation site on GitHub Pages #42 was gated green and then refused at the push:refusing to allow a Personal Access Token to create or update workflow .github/workflows/pages.yml without workflow scope. The commit was intact and is what this branch carries, pushed under acredential that has the scope. Until the loop's own token has it, any issue that touches
.github/workflows/will pass every check and then fail to land.🤖 Generated with Claude Code