Skip to content

Repair documentation capability parity - #632

Merged
jonathanong merged 7 commits into
mainfrom
agent-docs-parity
Aug 10, 2026
Merged

Repair documentation capability parity#632
jonathanong merged 7 commits into
mainfrom
agent-docs-parity

Conversation

@jonathanong

@jonathanong jonathanong commented Aug 9, 2026

Copy link
Copy Markdown
Owner

What changed

  • index all stable CLI command docs, including data-pw, effects, rsc-callers, and registry-extension
  • document the complete runtime Node export inventory and omitted query APIs
  • update the no-mistakes skill for resource edges, baseUrl resolution, and analyzeProject reuse
  • narrow the README capability claim and replace hardcoded docs coverage lists with source-derived CLI/export guards

Why

The implementation had stable commands and Node exports that agents could not discover from the primary indexes. The old docs test passed while omissions remained because its inventory was hand-maintained.

Checks

  • CARGO_TARGET_DIR=/private/tmp/docs-target RUSTC_WRAPPER= cargo test -p no-mistakes --test docs_coverage
  • node --test packages/no-mistakes/scripts/type-docs.test.js packages/no-mistakes/scripts/api.test.js
  • cargo fmt --all -- --check
  • git diff --check
  • GitHub Test CI: passed (Rust coverage, lint/package, JavaScript, AST, benchmarks)

Root cause

CLI and API documentation inventories drifted from source; the skill also retained a stale baseUrl limitation.

Shepherd Journal

  • Codecov's transient publishing state cleared; the final Rust and JavaScript coverage gates passed.
  • CodSpeed reported a 10.21% memory delta in facts/imports_and_symbols. This PR changes only documentation and a documentation test, with no production analysis or benchmark code path changes, so the result is treated as measurement noise rather than a code regression.
  • Fixed the nested Clap command documentation guard and corrected the JSONC example; the CodSpeed memory-only regression is unrelated to these docs/test changes and was left for explicit acknowledgement rather than a speculative performance change.
  • Codecov currently reports no coverage information on head while the Rust/coverage workflow remains in progress; this is an external upload-state failure, so no source change is warranted.
  • Codecov currently reports no coverage information on head while Rust coverage is still in progress; the external upload-state failure does not warrant a source change.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 9, 2026
@coderabbitai

This comment has been minimized.

@sourcery-ai

This comment has been minimized.

@codecov

This comment has been minimized.

@codspeed-hq

This comment has been minimized.

@jongleberry-bot
jongleberry-bot marked this pull request as ready for review August 9, 2026 23:57
chatgpt-codex-connector[bot]

This comment was marked as resolved.

coderabbitai[bot]
coderabbitai Bot previously requested changes Aug 10, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@skills/no-mistakes/references/limits-and-fallbacks.md`:
- Around line 12-16: Update the compilerOptions example near the baseUrl
explanation so its fenced language is jsonc, or move the // explanation outside
the code block; keep the tsconfig.json example and its meaning unchanged.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 19e678f2-306d-44ea-916b-f76f5ab46f9b

📥 Commits

Reviewing files that changed from the base of the PR and between 287453d and f96e881.

📒 Files selected for processing (6)
  • README.md
  • crates/no-mistakes/tests/docs_coverage.rs
  • docs/cli/README.md
  • docs/node-api.md
  • skills/no-mistakes/SKILL.md
  • skills/no-mistakes/references/limits-and-fallbacks.md

Comment thread skills/no-mistakes/references/limits-and-fallbacks.md Outdated
@jonathanong
jonathanong enabled auto-merge (squash) August 10, 2026 03:36
@jonathanong
jonathanong dismissed coderabbitai[bot]’s stale review August 10, 2026 16:06

Fixed nested Clap command documentation coverage and corrected the JSONC example; CodSpeed's docs-only memory result remains explicitly documented for acknowledgement.

chatgpt-codex-connector[bot]

This comment was marked as resolved.

@jongleberry-bot
jongleberry-bot marked this pull request as draft August 10, 2026 16:15
auto-merge was automatically disabled August 10, 2026 16:15

Pull request was converted to draft

@jongleberry-bot
jongleberry-bot marked this pull request as ready for review August 10, 2026 16:30
@jonathanong
jonathanong marked this pull request as draft August 10, 2026 16:32
chatgpt-codex-connector[bot]

This comment was marked as resolved.

@jongleberry-bot
jongleberry-bot marked this pull request as ready for review August 10, 2026 16:38
coderabbitai[bot]
coderabbitai Bot previously requested changes Aug 10, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@crates/no-mistakes/tests/docs_coverage.rs`:
- Around line 193-209: Update the runtime inventory parsing in the documentation
coverage test around documented_exports to extract both the export name and API
column, then assert the API value is non-empty for every documented export.
Preserve the exact export-set comparison while strengthening the per-row
validation associated with source_exports.

In `@crates/no-mistakes/tests/support/docs_coverage_cli_helpers.rs`:
- Around line 4-16: Replace the raw recursive traversal in rust_sources with
Git-aware source discovery that excludes ignored files and safely handles
directory symlinks; preferably pass a Git-visible file inventory into the test,
otherwise use an ignore-aware walker while preserving sorted Rust-file results.
- Around line 21-50: Update subcommand_enums to parse command attributes
structurally instead of searching for the exact #[command(subcommand)] byte
sequence, including multiline attributes with whitespace around subcommand. Add
a fixture covering a multiline #[command(...)] attribute and ensure the existing
parent struct and command field extraction remains correct.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a89d0456-e875-4fc2-b227-5958eb119e3d

📥 Commits

Reviewing files that changed from the base of the PR and between f96e881 and 7cc1def.

📒 Files selected for processing (3)
  • crates/no-mistakes/tests/docs_coverage.rs
  • crates/no-mistakes/tests/support/docs_coverage_cli_helpers.rs
  • skills/no-mistakes/references/limits-and-fallbacks.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • skills/no-mistakes/references/limits-and-fallbacks.md

Comment thread crates/no-mistakes/tests/docs_coverage.rs Outdated
Comment thread crates/no-mistakes/tests/support/docs_coverage_cli_helpers.rs
Comment thread crates/no-mistakes/tests/support/docs_coverage_cli_helpers.rs Outdated
@jonathanong
jonathanong dismissed coderabbitai[bot]’s stale review August 10, 2026 16:50

Hardened runtime API-row validation, switched command discovery to Git-aware files with structural syn parsing, and added a multiline attribute fixture.

coderabbitai[bot]
coderabbitai Bot previously requested changes Aug 10, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@crates/no-mistakes/tests/support/docs_coverage_cli_helpers.rs`:
- Around line 64-96: The subcommand_enums function only scans top-level items,
so Clap structs inside inline modules are omitted. Update its item traversal to
recursively inspect each Item::Mod content while preserving the existing struct
and field extraction, and add a fixture under fixtures/docs-coverage/ covering
an inline subcommand declaration.
- Around line 82-92: The clap subcommand type extraction must unwrap a
single-segment Option before enum lookup. Update the Type::Path handling to
inspect Option’s GenericArgument::Type and return the inner type’s enum name,
while preserving existing named-path behavior; add regression coverage for an
optional subcommand field.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: bc6d0eb8-88ec-4f93-8e3a-a984dbff366f

📥 Commits

Reviewing files that changed from the base of the PR and between 7cc1def and 5d13b3f.

📒 Files selected for processing (3)
  • crates/no-mistakes/tests/docs_coverage.rs
  • crates/no-mistakes/tests/support/docs_coverage_cli_helpers.rs
  • fixtures/docs-coverage/multiline-subcommand/fixture.rs
🚧 Files skipped from review as they are similar to previous changes (1)
  • crates/no-mistakes/tests/docs_coverage.rs

Comment thread crates/no-mistakes/tests/support/docs_coverage_cli_helpers.rs Outdated
Comment thread crates/no-mistakes/tests/support/docs_coverage_cli_helpers.rs Outdated
@jonathanong
jonathanong marked this pull request as draft August 10, 2026 16:59
@jonathanong
jonathanong dismissed coderabbitai[bot]’s stale review August 10, 2026 17:00

Added recursive inline-module and optional-subcommand parsing with fixture-backed tests.

@jonathanong
jonathanong marked this pull request as ready for review August 10, 2026 17:20
sourcery-ai[bot]

This comment was marked as resolved.

@jonathanong
jonathanong merged commit 4ffcf14 into main Aug 10, 2026
23 checks passed
@jonathanong
jonathanong deleted the agent-docs-parity branch August 10, 2026 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant