docs: fill in user guide overview and configuration reference - #101
Merged
Merged
Conversation
Adds the two pages the docs/sections placeholder was waiting for: - Overview: feature areas (C++ checks, license headers, changelog management, git tag utilities) and a full CLI command reference with examples for all 8 console scripts. - Configuration File: complete devops.toml/.devops.toml reference, section by section and key by key, with types, defaults, discovery rules, and the CHANGELOG.md insertion-marker format it depends on. All details verified directly against src/devops/config/*.py and src/devops/scripts/*.py rather than taken from memory. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0126spNDGtqDKMoYtuPT7JfW
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.
Summary
devops.toml/.devops.tomlreference: discovery rules (search order, what happens if none/multiple are found), every[exclude]/[logging]/[git]/[cpp]/[file]key with its type/default/description, a full example file, and theCHANGELOG.mdinsertion-marker format the changelog commands rely on.src/devops/config/*.pyandsrc/devops/scripts/*.py(not summarized from memory) to keep this accurate as the source of truth.Test plan
sphinx-build -b html -W docs/source docs/build/htmlsucceeds with no warnings, including all:ref:cross-references between the two new pages resolving correctly🤖 Generated with Claude Code
https://claude.ai/code/session_0126spNDGtqDKMoYtuPT7JfW