docs: AGENTS conventions (self-doc, CLI rules, --feature trigger) + roadmap design decisions - #193
Merged
Merged
Conversation
…oadmap decisions Per the directive to put enforcement rules in the repo, not just memory: AGENTS.md gains two sections: - Self-documenting features: the registry + globals are the doc SOT; every feature add/change updates its Descriptor.summary / GlobalFlag entry + kHelpText in the same change, so --help/--man/--markdown stay complete. - CLI conventions: flag scope by dash count (--global vs -primary; -h/-q/-help/ -version are special-cased compat globals); flag-only, no subcommands; and a user-toggleable boolean capability is a --feature, not a one-off flag. TODO.md roadmap decisions (design phase, accounting for existing code): - #43 parallel traversal + --sort: already BUILT (ReadPool, sort modes, tests, tsan cell); remaining is a CLI bashtest. - #45 --exact/--path-encoding: default = filesystem-native (natural per-platform case behavior); --exact forces verbatim byte matching; --path-encoding=raw|escape. - #73 --feature: PARKED (no customer yet) with the full ready-to-build design + a trigger (first boolean capability builds it); trigger mirrored in AGENTS.md. - #54 mode mechanism: subsumed by --config (no --mode flag; --modern deferred).
helly25
enabled auto-merge (squash)
June 28, 2026 13:13
…ns-and-73-park # Conflicts: # TODO.md
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.
Puts the enforcement rules in the repo (not just agent memory), and settles the roadmap design you asked for.
AGENTS.md - two new sections:
globals.ccare the doc SOT; every feature add/change updates itsDescriptor.summary/GlobalFlagentry +kHelpTextin the same change, so--help/--man/--markdownstay complete by construction.--feature, not a one-off flag - the trigger for the parked docs: config system spec (layered .xffrc + root-owned system policy) #73.TODO.md - design decisions (accounting for existing code):
--sort: already built (ReadPool, sort modes, tests, tsan cell); only a CLI bashtest remains.--exact/--path-encoding: default = filesystem-native natural behavior (case-folding per volume);--exactforces verbatim bytes;--path-encoding=raw|escape.--feature: parked (no customer) with the full ready-to-build design + a trigger.--config.(Other code conventions - string_view params, SizeIs/IsEmpty, trailing-comma tables - were already added to STYLE_CPP.md.) Docs-only; markdown-align + em-dash gates pass.