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

feat(docs): Add abilities from the Move book #3629

Merged
merged 15 commits into from
Nov 13, 2024

Conversation

salaheldinsoliman
Copy link
Contributor

@salaheldinsoliman salaheldinsoliman commented Oct 24, 2024

Description of change

Add docs about structs and abilities from the move book, and link it to our docs

Links to any relevant issues

Related to #3744

Type of change

Choose a type of change, and delete any options that are not relevant.

  • Documentation Enhancement

How the change has been tested

Docs built locally

Make sure to provide instructions for the maintainer as well as any relevant configurations.

Change checklist

Tick the boxes that are relevant to your changes, and delete any items that are not.

  • 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

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 24, 2024
Signed-off-by: salaheldinsoliman <[email protected]>
@salaheldinsoliman salaheldinsoliman force-pushed the devx/add-MoveBook-to-docs branch from d078e0f to 67c08d6 Compare October 25, 2024 10:55
@salaheldinsoliman salaheldinsoliman changed the title Devx/add move book to docs feat(docs): Add abilities from the Move book Oct 25, 2024
@salaheldinsoliman salaheldinsoliman marked this pull request as ready for review October 25, 2024 10:58
@salaheldinsoliman salaheldinsoliman requested a review from a team as a code owner October 25, 2024 10:58
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

@lucas-tortora lucas-tortora left a comment

Choose a reason for hiding this comment

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

Great addition :)

@@ -0,0 +1,84 @@
# Visibility Modifiers
Copy link
Contributor

Choose a reason for hiding this comment

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

This article overlaps with https://docs.iota.org/developer/iota-101/move-overview/entry-functions. WDYT about merging them?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The one added gives an overview of visibility modifiers, while https://docs.iota.org/developer/iota-101/move-overview/entry-functions explains when and why to use entry, public and public entry
I think we should keep them separate, while mentioning entry-functions.mdx in the newly added overview
Does that make sense?

docs/content/sidebars/developer.js Show resolved Hide resolved
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Signed-off-by: salaheldinsoliman <[email protected]>
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

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.

Please add Title and Description to other pages as well, the rest looks good to me. Good Work 👍

@salaheldinsoliman salaheldinsoliman linked an issue Nov 7, 2024 that may be closed by this pull request
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@salaheldinsoliman salaheldinsoliman merged commit 9d050a7 into develop Nov 13, 2024
31 of 32 checks passed
@salaheldinsoliman salaheldinsoliman deleted the devx/add-MoveBook-to-docs branch November 13, 2024 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add abilities section to the docs
4 participants