Skip to content

Point Rust doc strings at the moved README sections (cleanup) - #229

Merged
nevermemo merged 1 commit into
mainfrom
chore/cleanup-readme-pointers
Oct 23, 2026
Merged

nevermemo merged 1 commit into
mainfrom
chore/cleanup-readme-pointers

Conversation

@nevermemo

Copy link
Copy Markdown
Owner

Follow-up to the README trim (PR 228): Rust text that named README sections now names the guide that holds them.

  • src/rest.rs: the OpenAPI descriptions ("MCP tools" table, full semantics) and a doc comment now point at docs/reference/mcp-and-rest.md. tests/golden/surface_flags_off.json carries these descriptions and changes with them (12 lines, description text only).
  • xtask/src/main.rs help text and xtask/src/mine.rs module doc now point at docs/reference/retrieval.md.
  • lci-core/src/config/profile.rs doc comments ("Verify on read", "Map freshness", "Paths on cards") and one test comment in tests/cases/navigation.rs now point at docs/reference/cli.md.

No behaviour change beyond the two OpenAPI description strings. Local: cargo test --test integration recipes:: 6/6, cargo fmt --check clean.

🤖 Generated with Claude Code

The OpenAPI descriptions, the xtask help text and config doc comments named
README sections that moved to docs/reference in cleanup S2b. The surface golden
carries the two OpenAPI descriptions and changes with them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@nevermemo
nevermemo merged commit 3c3092f into main Oct 23, 2026
8 checks passed
@nevermemo
nevermemo deleted the chore/cleanup-readme-pointers branch October 23, 2026 22:51
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