-
Notifications
You must be signed in to change notification settings - Fork 14
[docs] cli node commands #818
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
neotheprogramist
wants to merge
13
commits into
master
Choose a base branch
from
ECTM-9687-cli-node-commands-docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
@neotheprogramist let's limit the scope of this PR to just rust docs. I would suggest to drop those markdown files for now. They look very neat but also fall somewhat out of line. So let's focus on rust-docs for the code. |
gilligan
reviewed
May 26, 2025
gilligan
reviewed
May 26, 2025
gilligan
reviewed
May 26, 2025
LGLO
reviewed
May 26, 2025
gilligan
reviewed
May 27, 2025
gilligan
reviewed
May 27, 2025
gilligan
reviewed
May 27, 2025
gilligan
reviewed
May 27, 2025
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.
Description
This PR adds comprehensive documentation for the
partner-chains-node-commands
crate, which provides the CLI interface for Partner Chains node operations. The documentation package includes:Changes Made
1. Enhanced
src/lib.rs
with complete API documentationAriadneParametersCmd
,SidechainParamsCmd
,RegistrationStatusCmd
)PartnerChainsSubcommand
enum with all 8 command variantsrun
function with type parameters, arguments, and usage examplessetup_log4rs
,print_result
) with comprehensive documentation2. Created comprehensive
README.md
3. Added
SUMMARY.md
documentation indexDocumentation Quality
This documentation serves multiple audiences:
The documentation follows Rust best practices with rustdoc conventions and provides comprehensive coverage suitable for both end-users and developers integrating with the Partner Chains ecosystem.
Checklist
changelog.md
for affected crateNotes
changelog.md
for thepartner-chains-node-commands
crate to note documentation improvements