Skip to content

Add Reference section with CLI, configuration, and state file documentation#83

Open
ijac13 wants to merge 1 commit intodocs-v3from
pr8-reference
Open

Add Reference section with CLI, configuration, and state file documentation#83
ijac13 wants to merge 1 commit intodocs-v3from
pr8-reference

Conversation

@ijac13
Copy link
Contributor

@ijac13 ijac13 commented Mar 3, 2026

Summary

  • Create new Reference section (docs/7-reference/) with technical documentation
  • Add configuration.md documenting recce.yml preset check configuration
  • Add state-file.md documenting state file format and usage patterns
  • Add cli-reference.md documenting recce and recce-cloud CLI commands
  • Rename "Technical Concepts" navigation to "Reference" in mkdocs.yml

Changes

File Action Description
7-reference/configuration.md Created Preset check configuration reference with parameters and examples for all check types
7-reference/state-file.md Created State file format, saving methods, and workflow examples
7-reference/cli-reference.md Created CLI commands for recce (server, run, summary, debug) and recce-cloud (upload)
mkdocs.yml Updated Navigation renamed from "Technical Concepts" to "Reference"

Test plan

  • Verify mkdocs builds without errors
  • Check Reference section appears in navigation
  • Confirm all three reference pages load correctly
  • Review cross-references between reference pages work

🤖 Generated with Claude Code

…tation

- Create 7-reference/configuration.md: Document recce.yml preset check
  configuration with overview, parameters, and examples for all check types
- Create 7-reference/state-file.md: Document state file format, saving methods,
  and usage patterns for development and PR review workflows
- Create 7-reference/cli-reference.md: Document recce and recce-cloud CLI
  commands including server, run, summary, debug, and upload
- Update mkdocs.yml: Rename "Technical Concepts" to "Reference" and update
  navigation paths to new 7-reference section

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant