docs: align release documentation and verify Markdown examples - #127
Merged
Merged
Conversation
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.
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.git diff --checkpassed.