docs: standardize repository decisions and change records - #2
Merged
Merged
Conversation
danielblignaut
marked this pull request as ready for review
September 7, 2026 16:25
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.
Contributors now use the same ADR and change-record workflow, with agent instructions, PR/pre-commit skills, templates, and a PR documentation checklist requiring records to stay current through review. Existing repository-specific guidance and decision history are preserved.
Validation: checked changed skill frontmatter, local documentation links, Markdown fences, required record sections, and
git diff --check. Runtime builds, browser flows, and provider tests were not run for this documentation change.Documentation: decision, complete update record. Related repositories can adopt this convention independently; no coordinated application deployment or secret migration is required.
The branch was reconstructed from the fetched default branch in an isolated worktree. Unrelated changes in the original checkout are excluded. Review comments and current checks were inspected before merge; no external review bot was requested.
The shared Mintlify submodule moves from
docs/topublic-docs/, preserving its pinned commit. The Go generator default, Makefile, README, and provider skills change together. Existing checkouts must preserve submodule changes and rungit submodule deinit docsbefore updating the branch, then rungit submodule syncandgit submodule update --init --recursive public-docs; custom scripts using the old path must be updated or setDOCS_REPO_DIR. Focusedgo test ./internal/docgen ./tools/generatedocspassed. A temporary initialized-submodule fixture also verified the deinit-before-update migration leaves a clean checkout and independent documentation paths.