Skip to content

feat(docs): Add docs to the Notarization codebase#52

Merged
itsyaasir merged 7 commits intodevelopfrom
feat/add-docs
Jun 19, 2025
Merged

feat(docs): Add docs to the Notarization codebase#52
itsyaasir merged 7 commits intodevelopfrom
feat/add-docs

Conversation

@itsyaasir
Copy link
Contributor

Description of change

Links to any relevant issues

Type of change

  • Bug fix (a non-breaking change which fixes an issue)
  • Enhancement (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Fix

How the change has been tested

Change checklist

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that new and existing unit tests pass locally with my changes
  • I have updated the CHANGELOG.md, if my changes are significant enough

- Added comprehensive documentation for the notarization client, including transaction flow and configuration methods.
- Improved the package management module with detailed comments on package registry functions.
- Expanded the builder module documentation to clarify the creation of locked and dynamic notarizations.
- Introduced new methods for state management, including state creation from bytes and strings.
- Enhanced metadata handling with clear examples for updating and transferring notarizations.
- Updated core modules to improve clarity and usability for developers interacting with notarization operations.
@itsyaasir itsyaasir self-assigned this Jun 13, 2025
@itsyaasir itsyaasir changed the base branch from main to develop June 13, 2025 17:19
- Changed chain ID and published IDs in Move.lock for localnet configuration.
- Updated Rust documentation examples in full_client.rs, builder.rs, and state.rs to use correct module paths and changed code blocks to ignore for better clarity.
- Enhanced examples for creating states from strings and bytes, ensuring consistency across documentation.
@itsyaasir itsyaasir requested a review from chrisgitiota June 17, 2025 06:23
@itsyaasir itsyaasir linked an issue Jun 17, 2025 that may be closed by this pull request
@itsyaasir
Copy link
Contributor Author

closes #52

@itsyaasir itsyaasir merged commit 50ff879 into develop Jun 19, 2025
5 checks passed
@itsyaasir itsyaasir deleted the feat/add-docs branch June 19, 2025 03:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task]: Write notarization doc comments in the code

1 participant