Skip to content
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

fix(docs): Add missing framework docs #4587

Merged
merged 1 commit into from
Dec 23, 2024

Conversation

Dr-Electron
Copy link
Contributor

@Dr-Electron Dr-Electron commented Dec 20, 2024

Description of change

A community member reported that we don't have docs for u128, but SUI has. So I looked into it. Seems like we only documented parts of the move sodlib that were dependencies of another framework package. So I guess the deep book has u128 as dependency, hence why it didn't show up on our side.
I now also create the move sodlib docs.

Links to any relevant issues

Fixes #4564

Type of change

  • Documentation Fix

How the change has been tested

Run locally.

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

@Dr-Electron Dr-Electron requested a review from a team December 20, 2024 13:26
@Dr-Electron Dr-Electron requested review from a team as code owners December 20, 2024 13:26
@iota-ci iota-ci added the devx Issues related to the DevX team label Dec 20, 2024
Copy link
Contributor

@vivekjain23 vivekjain23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@thibault-martinez thibault-martinez merged commit 8650f64 into develop Dec 23, 2024
42 checks passed
@thibault-martinez thibault-martinez deleted the devx/fix-missing-framework-docs branch December 23, 2024 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devx Issues related to the DevX team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Check why framework docs are not created correctly
4 participants