Skip to content

Generalize receiver analysis documentation#1133

Merged
DavidBakerEffendi merged 1 commit into
masterfrom
dave/generalize-receiver-docs
Jul 24, 2026
Merged

Generalize receiver analysis documentation#1133
DavidBakerEffendi merged 1 commit into
masterfrom
dave/generalize-receiver-docs

Conversation

@DavidBakerEffendi

Copy link
Copy Markdown
Collaborator

Summary

  • replace the static receiver-language support inventory with an adapter-neutral receiver-analysis contract
  • make each input's runtime outcome and diagnostics authoritative for capability decisions
  • align the capability guide, CodeQuery JSON/RQL references, tutorials, Python client docs, evaluation guidance, and public schema help

Why

Receiver tracking now consumes shared structured facts supplied by the selected adapter. A hand-maintained list of included and excluded languages can drift as adapters evolve and can imply stronger guarantees than a particular source form or workspace supports. The documentation now describes the stable contract and directs callers to inspect receiver_analysis outcomes, diagnostics, truncation, budgets, and available evidence.

Language-specific tutorials remain examples of the shared contract rather than defining its coverage.

User impact

Readers no longer need to reconcile duplicated receiver-support lists across documentation surfaces. They get one consistent rule: query the selected adapter and treat the returned structured outcome and diagnostics as authoritative for that input.

Follow-up #1132 tracks runnable Rust and Python library cookbook examples for query_code.

Validation

  • npm run build — 57 pages and 5,383 internal links
  • cargo test --test code_query_tutorials receiver_traversal_tutorial
  • cargo fmt --all -- --check
  • scripts/with-isolated-cargo-target.sh cargo clippy --all-targets --all-features -- -D warnings using the pinned Rust 1.96.0 toolchain
  • git diff --check origin/master...HEAD
  • visually inspected the rendered capabilities and receiver-traversal pages

Replace the static language support inventory with the adapter-neutral receiver-analysis contract so documentation does not drift as adapters evolve.

Make runtime outcomes and diagnostics authoritative for each input, and align the public JSON, RQL, tutorial, client, and schema-help wording with that model.
@DavidBakerEffendi
DavidBakerEffendi marked this pull request as ready for review July 24, 2026 06:44
@DavidBakerEffendi
DavidBakerEffendi merged commit 7748331 into master Jul 24, 2026
22 checks passed
@DavidBakerEffendi
DavidBakerEffendi deleted the dave/generalize-receiver-docs branch July 24, 2026 07:14
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