docs(rust): API reference master

[WomB0ComB0]

Auto-generated by API docs (Rust) in
resq-software/crates for ref master
(run: 25624650511).

Regenerated stub pages under sdks/rust/api/. Each page
embeds the crate's README and links to docs.rs for the
canonical API reference.

Summary by CodeRabbit

Rust SDK Documentation Update

• Documentation
  • Restructured and expanded Rust SDK API documentation with improved organization
  • Added comprehensive module-level documentation pages for resq-ai (config, provider, token), resq-bin (analysis), resq-cli (all command modules), resq-dsa (data structures), and resq-tui (terminal components)
  • Improved navigation structure with more granular documentation paths for better discoverability

[coderabbitai]

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Restructures Rust SDK documentation from flat top-level files into granular nested module pages. Updated navigation manifests (docs.json, _pages.json) and the README to reflect the new organization. Removed monolithic crate documentation and added detailed submodule pages for resq-ai, resq-bin, resq-cli, resq-dsa, and resq-tui.

Changes

Rust SDK Documentation Restructuring

Layer / File(s)	Summary
Navigation Configuration docs.json, sdks/rust/api/_pages.json, sdks/rust/api/README.mdx	Updated docs.json and _pages.json to reference nested subpage routes instead of top-level crate entries. Updated README.mdx to clarify documentation links for library versus binary-only crates.
Top-Level Crate Documentation Removal sdks/rust/api/resq-ai.md, sdks/rust/api/resq-bin.md, sdks/rust/api/resq-cli.md, sdks/rust/api/resq-dsa.md, sdks/rust/api/resq-tui.md	Removed monolithic crate-level documentation files that are now replaced by granular nested module documentation.
ResQ-AI Module Documentation sdks/rust/api/resq-ai/index.md, sdks/rust/api/resq-ai/config.md, sdks/rust/api/resq-ai/provider.md, sdks/rust/api/resq-ai/token.md	Added index and module-level documentation for the multi-provider LLM abstraction crate, covering configuration cascades, provider selection, token estimation, and truncation utilities.
ResQ-Bin Module Documentation sdks/rust/api/resq-bin/index.md, sdks/rust/api/resq-bin/bin_explorer.md, sdks/rust/api/resq-bin/analysis.md	Added index and module pages documenting binary analysis APIs, including structures for analyzing binary metadata, disassembly coverage, and per-function instruction reports.
ResQ-CLI Command Documentation sdks/rust/api/resq-cli/index.md, sdks/rust/api/resq-cli/resq_cli.md, sdks/rust/api/resq-cli/commands.md, sdks/rust/api/resq-cli/commands/*.md, sdks/rust/api/resq-cli/gitignore.md, sdks/rust/api/resq-cli/utils.md	Added comprehensive CLI documentation with index, module overview, and individual pages for each command (audit, commit, completions, copyright, dev, docs, explore, format, hook_templates, hooks, pre_commit, secrets, version), plus utility modules (gitignore, utils).
ResQ-DSA Data Structure Documentation sdks/rust/api/resq-dsa/index.md, sdks/rust/api/resq-dsa/resq_dsa.md, sdks/rust/api/resq-dsa/bloom.md, sdks/rust/api/resq-dsa/count_min.md, sdks/rust/api/resq-dsa/graph.md, sdks/rust/api/resq-dsa/heap.md, sdks/rust/api/resq-dsa/trie.md	Added modular documentation for data structures and algorithms crate, covering Bloom filters, Count-Min sketches, graph pathfinding (BFS/Dijkstra/A*), bounded heaps, and tries with Rabin-Karp string matching.
ResQ-TUI Module Documentation sdks/rust/api/resq-tui/index.md, sdks/rust/api/resq-tui/resq_tui.md, sdks/rust/api/resq-tui/terminal.md	Added index and module pages for the TUI library crate, documenting theme configuration, drawing utilities, and terminal lifecycle management (init/restore/run_loop) with RAII guards.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related PRs

• resq-software/docs#6: Modifies Rust SDK documentation manifests and adds/updates multiple Rust SDK documentation pages alongside docs.json updates.

Poem

A rabbit hops through docs so grand,
Organizing code with careful hand.
From flat to nested, trees now grow,
Where Bloom filters and DSAs all show! 🐰📚✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs(rust): API reference master' is directly related to the changeset, which regenerates Rust SDK API reference documentation pages for the master branch.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch auto/rust-api-master

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Code Review

This pull request significantly expands the auto-generated API documentation for the Rust SDKs, replacing high-level crate summaries with granular, module-level documentation for resq-ai, resq-bin, resq-cli, resq-dsa, and resq-tui. The review feedback highlights several systemic issues with the documentation generator, including the generation of invalid Rust syntax for generic bounds, the exposure of internal implementation details (such as Serde's private types), and malformed trait implementation signatures. Additionally, some summaries are truncated, and it is recommended to fix these at the source-level doc comments to ensure persistence across regeneration cycles.

[gemini-code-assist]

The generated signature for add contains invalid Rust syntax (<impl AsRef<[u8]>>) and an unresolved placeholder (impl Trait). This indicates a systemic issue in the documentation generator's handling of generic bounds and trait implementations.

This should be addressed in the generator logic to ensure that API references for generic methods are rendered correctly across the SDK.

[gemini-code-assist]

The generated documentation is exposing internal implementation details such as _serde::__private228::Result. The generator should be configured to resolve these to their public-facing types (e.g., serde::Result or Result) to maintain clarity for end-users and avoid exposing unstable internals.

[gemini-code-assist]

The summary for hook_content in the Contents section is truncated ("...or None if the"). This usually happens when the generator only captures the first line of a doc comment.

As per the general rules, please apply the fix to the source-level documentation (e.g., the Rust doc comments) by ensuring the first sentence is concise and fits on a single line.

References

1. When fixing errors in auto-generated documentation, apply the changes to the source-level documentation (e.g., XML doc comments) instead of the generated files to ensure the fixes persist across regeneration cycles.

[gemini-code-assist]

The trait implementation signature is malformed (<Self as >::Target). This suggests the generator is failing to correctly resolve the trait name in the associated type projection for the DerefMut implementation. This makes the documentation for the TerminalGuard RAII wrapper confusing.