docs(rust): API reference master#49
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (15)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
github-actions
Bot
added
area:content
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces auto-generated documentation for the ResQ Rust SDK crates, including a new Rust group in the documentation configuration and individual markdown files for crates like resq-bin, resq-dsa, and resq-tui. The reviewer provided feedback regarding MDX safety for curly braces in resq-bin.md, correcting an external license link in resq-dsa.md, and addressing a version inconsistency in the resq-tui.md installation example. All feedback highlights the importance of applying these fixes to the source-level documentation rather than the generated files to ensure they persist through future regeneration cycles.
|
|
||
| ### Cache Storage Format | ||
|
|
||
| Each entry is stored as a JSON file named `{crc32_hex}.json` containing the full `BinaryReport` structure. |
There was a problem hiding this comment.
The curly braces in {crc32_hex} will be interpreted as a JavaScript expression by MDX. Please wrap this in a code span or escape it in the source-level documentation (e.g., Rust doc comments) rather than this generated file to ensure the fix persists across regeneration cycles and respects MDX safety.
References
- When post-processing Markdown files for MDX safety, use parsing logic that respects CommonMark inline code span rules to avoid incorrectly modifying content inside code snippets.
- Apply changes to source-level documentation (e.g., XML doc comments) instead of generated files to ensure fixes persist across regeneration cycles.
|
|
||
| [](https://crates.io/crates/resq-dsa) | ||
| [](https://docs.rs/resq-dsa) | ||
| [](https://github.com/wombocombo/wrk/blob/master/LICENSE) |
There was a problem hiding this comment.
The license badge link points to an external repository. This fix must be applied to the source-level documentation (e.g., the source README) instead of this generated file to ensure the fix persists across regeneration cycles.
References
- Apply changes to source-level documentation (e.g., XML doc comments) instead of generated files to ensure fixes persist across regeneration cycles.
|
|
||
| ```toml | ||
| [dependencies] | ||
| resq-tui = "0.1.4" |
There was a problem hiding this comment.
The version in the installation example is inconsistent with the current crate version. Please apply the fix to the source-level documentation. Note that temporary inconsistencies are acceptable if they are to be resolved by a separate, referenced pull request.
References
- Apply changes to source-level documentation (e.g., XML doc comments) instead of generated files to ensure fixes persist across regeneration cycles.
- It is acceptable for a pull request to have temporary inconsistencies if these will be resolved by a separate, referenced pull request.
Auto-PR #50 (cpp) merged first and added the C++ subgroup to docs.json's Generated Package References. Rebasing #49 (rust) over that produced a docs.json conflict. Resolve by re-running scripts/splice-sdk-nav.py, which is the canonical local splicer. Discovered while resolving that the script only knew about TS/Python/.NET, so adding Rust + C++ to its lang_specs at the same time. Without that, every local splice run would silently drop Rust + C++ subgroups.
The current Rust template emits one stub page per crate with name +
version + embedded README + a link out to docs.rs. Functional but
not what users expect from an SDK reference — they see prose, not
the type/function surface (modules, structs, traits, methods with
doc comments and examples) that the canonical rustdoc HTML at
github.io/crates already serves.
Use cargo-doc-md (the maintained rustdoc-JSON-to-markdown
converter) to render real API docs into Mintlify. JSON output
requires nightly so the workflow installs both stable + nightly
toolchains.
Hybrid pipeline: cargo-doc-md handles library crates (lib.rs);
README stubs remain the fallback for binary-only crates (TUIs:
resq-clean, resq-deploy, resq-flame, resq-health, resq-logs,
resq-perf — none of which have a public lib API to document).
Output layout:
- lib crates → OUTPUT_DIR/<crate>/index.md (landing) + per-module
siblings (resq_dsa/bloom.md, resq_dsa/graph.md, etc.)
- bin crates → OUTPUT_DIR/<crate>.md (single README stub)
The version banner injects after the H1 of each landing page so
both shapes carry the same metadata strip. Splice already handles
the dir-with-landing form (PR #61) and flat-file form (PR #49)
naturally.
Co-authored-by: Mike Odnis <engineer@resq.software>
…ly (#66) The Rust template's splice was the original flat version: every entry from _pages.json mapped to a standalone PAGE registration under the language group. This worked when every crate was a single stub page (PR #49 era), but PR #62 introduced multi-file output for library crates (resq-dsa with bloom.md, count_min.md, graph.md, ...). The flat splice rendered all those module pages as direct siblings of the language group rather than collapsing them into a `resq-dsa` group. Visible symptom: clicking `Resq dsa` in the sidebar showed only the index page; the per-module pages were registered but not discoverable from the nav (the user had to type each URL by hand or hope for autocomplete). The right-side TOC showed module structure but the left sidebar was flat. Replace with the hierarchical-with-landing splice from PR #61 (used by TS / .NET / Python / C++): each top-level dir under sdks/rust/api/ becomes a collapsible group with its index.md as the landing, and per-module pages as children. Single-file stub crates (binary-only TUIs) stay as leaf PAGEs. Local docs.json re-spliced with `scripts/splice-sdk-nav.py` so main reflects the corrected structure immediately. Verified Rust nav structure: 1 README + 6 leaf PAGEs (binary-only) + 5 GROUPs (library crates with rustdoc API) Co-authored-by: Mike Odnis <engineer@resq.software>
2 participants
Auto-generated by
API docs (Rust)inresq-software/cratesfor refmaster(run: 25620165949).
Regenerated stub pages under
sdks/rust/api/. Each pageembeds the crate's README and links to docs.rs for the
canonical API reference.