docs(config): document all real config sections + fix stale exclude list (bo-l9ny)#31
Merged
Conversation
…ist (bo-l9ny) docs/configuration.md covered only [index][embedding][search][hooks][git] [context][feedback] and showed a stale 6-pattern exclude list (config.rs ships 15). Brings the reference in sync with src/config.rs: - Fix [index].exclude to the full 15-pattern default. - Add the previously-undocumented sections to both the annotated TOML block and the Section Reference, with defaults verified against each Default impl: [server], [dependencies], [beads], [archive], [access], [sources], and the top-level [[groups]] / [[file_types]] / quipu_endpoint (shown as commented examples since they default to empty/unset). Defaults transcribed from config.rs (spot-checked: exclude list, beads, deps). The example TOML validates (tomllib parses it). configuration.md is a standalone doc (not in the mdbook/Vale/markdownlint scope). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YGrLvUVZAc383ZBpRhK86f
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.
Why
docs/configuration.mddocumented only[index][embedding][search][hooks][git][context][feedback]and showed a stale 6-patternexcludelist, whileconfig.rsships 15 patterns and many more sections. The doc drifted from the source of truth.What
Brought the reference in sync with
src/config.rs— defaults verified against eachDefaultimpl:[index].excludeto the full 15-pattern default.[server],[dependencies],[beads],[archive],[access],[sources][[groups]],[[file_types]], andquipu_endpoint— shown as commented examples since they default to empty/unset.Verification
config.rsand spot-checked against source (exclude list,[beads],[dependencies]).tomllibparses it cleanly; active top-level keys: access, archive, beads, context, dependencies, embedding, feedback, git, hooks, index, search, server, sources.configuration.mdis a standalone doc (not in the mdbookSUMMARY.md, Vale, or markdownlint scope), so no doc-CI gate applies; verified it's not referenced by the book.Closes bo-l9ny.