Document Rust applications and publish versioned SDK reference - #8422
Open
Amaury Chamayou (achamayou) wants to merge 1 commit into
Open
Amaury Chamayou (achamayou) wants to merge 1 commit into
Amaury Chamayou (achamayou) wants to merge 1 commit into
Conversation
Add a source-backed tutorial, public SDK contracts and doctests, and SDK-only rustdoc generation integrated with CCF's versioned Sphinx documentation. Validate generated API links and document the experimental interface's limits. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Stacked on #8200, targeting
achamayou-rust-interface-exploration.Rust application authors need a runnable path from CCF setup to authenticated requests, and API contracts comparable in quality to the existing C++ documentation. The initial Rust guide describes the interface but does not provide a source-backed walkthrough or generated API reference.
Implementation summary
Local validation passed: the full warnings-as-errors Sphinx build, 10 documentation-helper tests, SDK unit tests and doctests on Rust 1.90.0 and 1.93.1, sample
cargo check, andscripts/ci-checks.sh. The native Debugbasic_rusttarget also builds, and theccf_app_rust_testande2e_basic_rustCTest selections pass. The helper tests are wired into the existing documentation CI step; SDK doctests use the existing Rust test registration.Safety and compatibility
No application or bridge runtime behavior, ABI, ledger encoding, consensus, recovery, or mixed-version behavior changes. Rust edits add documentation, doctests, documentation lints and documentation-only visibility attributes; sample edits add snippet markers.
Rust documentation generation does not build a CCF executable.
SKIP_RUSTDOCis an explicit local-preview escape hatch, not used in publishing or CI. Native rustdoc retains its own presentation and search; Sphinx remains the versioned entry point and conceptual guide.