Defines the README command table for common Grounded CLI workflows.
From a checkout today. After the first PyPI release, install with pipx install grounded or run one-off commands with uvx grounded.
Good first candidates are facts that already cause confusion or repeated explanations:
Defines the README command table for common Grounded CLI workflows.
Defines the README section that shows the default Grounded project layout.
These source specs describe the current Grounded value proposition without making README.md the durable owner of those claims.
Plain string tags are useful for loose grouping. Use typed tags when the classification should be validated.
Start with protected generated blocks inside existing Markdown files. Full-file generation remains available for mature docs once the source specs and projection graph are complete.
Defines the README command table for common Grounded CLI workflows.
Use grounded context START when an LLM agent needs bounded project memory before modifying, extending, or reviewing a spec. START may be either an exact spec ID or a search query; exact active spec IDs take precedence. Search-resolved seeds must be verified before treating the pack as authoritative. Use grounded context --changed-files PATH [PATH ...] when the starting point is one or more changed files that should resolve through declared file bindings. The command resolves seed specs, includes those seeds, then includes active related specs up to the requested relationship depth and item limit. When bindable registry types declare bindings, --include-bindings exposes metadata for external artifacts such as implementation and test files. Binding metadata is separate from artifact content; this first slice reports that file contents are not included.
Defines the README section that summarizes the CLI workflow capabilities from command-owning decisions.
Defines the README section that points readers to the registry inspection command as a way to understand the active documentation graph.
Defines the README adoption ladder as structured generated documentation.
Good first candidates are facts that already cause confusion or repeated explanations:
Move durable claims into source specs first, then project a small README block from those specs. The README remains approachable, while CI can run grounded render --check to catch stale generated content.
Use Grounded when:
Defines the LLM workflows guide section that explains agent responsibilities from canonical rules and decisions.
Use grounded context START when an LLM agent needs bounded project memory before modifying, extending, or reviewing a spec. START may be either an exact spec ID or a search query; exact active spec IDs take precedence. Search-resolved seeds must be verified before treating the pack as authoritative. Use grounded context --changed-files PATH [PATH ...] when the starting point is one or more changed files that should resolve through declared file bindings. The command resolves seed specs, includes those seeds, then includes active related specs up to the requested relationship depth and item limit. When bindable registry types declare bindings, --include-bindings exposes metadata for external artifacts such as implementation and test files. Binding metadata is separate from artifact content; this first slice reports that file contents are not included.
Defines the README section that summarizes the CLI workflow capabilities from command-owning decisions.
Defines the README command table for common Grounded CLI workflows.
Defines the drift checks guide section that lists the main validation, audit, and verification guardrails.
Defines the README command table for common Grounded CLI workflows.
The GitHub Pages deployment workflow builds the root generated Grounded docs at the Pages site root and the Todo example site under todo/, then publishes them from an assembled Pages artifact. Rendered site directories remain ignored by git.
Defines the publishing guide section that summarizes publishing and generated documentation release decisions.