Skip to content

docs: align release documentation and verify Markdown examples - #127

Merged
strider2038 merged 1 commit into
mainfrom
docs/release-readiness
Oct 2, 2026
Merged

strider2038 merged 1 commit into
mainfrom
docs/release-readiness

Conversation

@strider2038

Copy link
Copy Markdown
Contributor

Documentation examples had drifted from the public API: translation snippets used removed methods, the README listed a violation that cannot occur, and group selection and custom violation translation were described incorrectly. Correct those examples and contracts across the guides, godoc, and AGENTS.md.

Shorten the README, move five detailed constraint guides into docs/, add a constraint catalog, and update installation, contribution, and release instructions. Add local Markdown link/heading checks and execution of complete Go examples to the local gate and shared CI. The checker currently covers 22 Markdown files and three complete examples; partial snippets link to executable examples where applicable. Library runtime behavior is unchanged.

Validation on Go 1.27.1:

  • bash scripts/test-all.sh: documentation checks and five checker regression tests, gofmt, vet, golangci-lint v2.13.2, unit/race tests, module tidy and verification passed.
  • Release tooling regressions: 13 shell checks, 17 release-candidate tests, and four security-report tests passed.
  • Verified all catalog API symbols against package sources; git diff --check passed.

@strider2038
strider2038 merged commit 2ceadd2 into main Oct 2, 2026
4 checks passed
@strider2038
strider2038 deleted the docs/release-readiness branch October 2, 2026 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant