docs: Add inline documentation for SDK External API and deploy via GitHub Pages #1288
Conversation
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
|
@miraclx Should the docs deploy only |
|
hey @varshith257 , pls comment on the corresponding github issue for assignment and reference the issue in the PR. |
|
❌ The PR description is missing these required sections:
This PR is blocked until this is fixed. |
1 similar comment
|
❌ The PR description is missing these required sections:
This PR is blocked until this is fixed. |
yeah just that |
E2E tests reportProtocol: ethereum
Protocol: icp
Protocol: near
Protocol: stellar
|
|
@miraclx Once this PR is merged into the master we can get live site of deployed docs of Before that we need to make sure GitHub Pages is enabled in the repository settings with the source set to the gh-pages branch |
|
@varshith257 is it ready for review? |
|
@antonpaisov Yes |
|
@varshith257 requested. pls message me on discord at @antonpaisov and provide me with your preferred email address there |
miraclx
reviewed
Jun 4, 2025
| /// ```rust,no_run | ||
| /// use calimero_sdk::{External, AccountId}; | ||
| /// | ||
| /// let proposal_id = External.propose() |
There was a problem hiding this comment.
this syntax External.propose() will be deprecated, it should instead be:
Suggested change
| /// let proposal_id = External.propose() | |
| /// let proposal_id = Self::external() | |
| /// .propose() |
where this is contained in an #[app::logic] method
| uses: Swatinem/rust-cache@v2 | ||
| with: | ||
| cache-on-failure: true | ||
| cache-all-crates: true |
There was a problem hiding this comment.
any reason for this directive? cache-all-crates
| @@ -1,6 +1,7 @@ | |||
| pub use {borsh, serde, serde_json}; | |||
|
|
|||
| pub mod env; | |||
| pub use env::ext::{AccountId, DraftProposal, External, ProposalAction, ProposalId}; | |||
miraclx
reviewed
Jun 4, 2025
Comment on lines
+33
to
+37
| - name: Deploy to GitHub Pages | ||
| uses: peaceiris/actions-gh-pages@v4 | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./target/doc |
6BDF
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.
[calimero-sdk]
Fixes
Description
This PR adds Rust doc for the
calimero_sdk cratefor the External API. It also includes a GitHub Actions workflow that builds and deploys the generated docs to GitHub Pages for easy reference.Test Plan
Ran
cargo doc -p calimero-sdk --no-depslocally, docs generated undertarget/doc/calimero_sdk/Verified GitHub Actions builds and deploys on master push.
Checked deployed docs are live at: https://varshith257.github.io/core/calimero_sdk/
Confirmed CSS/JS load properly and module structure appears as expected.
Documentation update
Documented external APIs in calimero-sdk