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.

Sign up for GitHub

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

Jump to bottom

feat(docs/developer/move-2024) ensure move 2024 and enums documented #3790

Merged
merged 31 commits into from
Nov 13, 2024
Merged

feat(docs/developer/move-2024) ensure move 2024 and enums documented #3790

merged 31 commits into from
Nov 13, 2024

Conversation

Dkwcs
Copy link
Contributor

@Dkwcs Dkwcs commented Oct 30, 2024

Description of change

Add a new page introducing Move 2024, and include the missing parts about its new features.

Links to any relevant issues

Fix #3248 .

Type of changes

  • Documentation Fix

How the change has been tested

pnpm iota-docs dev

Dkwcs and others added 3 commits October 25, 2024 10:26
@Dkwcs
feat(docs/advanced): add move 2024 introduction mdx for further updates
31f458f
@Dkwcs
refactor(docs/advanced): how to migrate section has been removed , mi…
23270c4 
…ssed sections like - (Macro Functions, Enums, Postfix `has` ability declarations, Type inference holes `_` on type annotations, Named blocks with enhanced control flow operations) have been added.

Renaming to IOTA
@nonast
refactor(docs/advanced): Update links
1bd4b23
@Dkwcs Dkwcs added documentation Improvements or additions to documentation vm-language Issues related to the VM & Language Team labels Oct 30, 2024
@Dkwcs Dkwcs requested review from valeriyr and miker83z October 30, 2024 12:34
@nonast nonast marked this pull request as ready for review October 31, 2024 12:10
@nonast nonast requested a review from a team as a code owner October 31, 2024 12:10
@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 4, 2024

✅ Vercel Preview Deployment is ready!

View Preview

@lzpap
Copy link
Member

lzpap commented Nov 7, 2024 •
edited
Loading

@Dkwcs We should make it clear that IOTA launches with Move 2024.beta edition, and there is no point in talking about legacy code migrations. We don't even support bytecode layout lower than 7 (enum addition version).

@miker83z
Copy link
Contributor

miker83z commented Nov 8, 2024

@lzpap

@Dkwcs We should make it clear that IOTA lanches with Move 2024.beta edition, and there is no point in talking about legacy code migrations. We don't even support bytecode layout lower than 7 (enum addition version).

@Dkwcs
This aspect can/must be clarified. For sure there are no on-chain packages that needs to be upgraded!
Still, though, many code examples and packages copied over from Sui are implemented using the "legacy" Move. So this page can be also of help if Move devs want to upgrade the code before even publishing it in IOTA.

So, I'd refine the migration concept to make it clear that we are not talking about on-chain migration, but more like Move code upgrade. So we still need an "old" vs "new" comparison. We cannot expect that all Move 2024 features are used correctly since the start given that there is not a great number of examples and docs related to it!

@Dkwcs
Copy link
Contributor Author

Dkwcs commented Nov 12, 2024 •
edited
Loading

@lzpap

@Dkwcs We should make it clear that IOTA lanches with Move 2024.beta edition, and there is no point in talking about legacy code migrations. We don't even support bytecode layout lower than 7 (enum addition version).

@Dkwcs This aspect can/must be clarified. For sure there are no on-chain packages that needs to be upgraded! Still, though, many code examples and packages copied over from Sui are implemented using the "legacy" Move. So this page can be also of help if Move devs want to upgrade the code before even publishing it in IOTA.

So, I'd refine the migration concept to make it clear that we are not talking about on-chain migration, but more like Move code upgrade. So we still need an "old" vs "new" comparison. We cannot expect that all Move 2024 features are used correctly since the start given that there is not a great number of examples and docs related to it!

@miker83z
Would you like to have a strict explanation like Levi mentioned?
Especially: remove alpha version mentions, reformulate “migration” sense?

@miker83z
Copy link
Contributor

@Dkwcs

@lzpap

@Dkwcs We should make it clear that IOTA lanches with Move 2024.beta edition, and there is no point in talking about legacy code migrations. We don't even support bytecode layout lower than 7 (enum addition version).

@Dkwcs This aspect can/must be clarified. For sure there are no on-chain packages that needs to be upgraded! Still, though, many code examples and packages copied over from Sui are implemented using the "legacy" Move. So this page can be also of help if Move devs want to upgrade the code before even publishing it in IOTA.
So, I'd refine the migration concept to make it clear that we are not talking about on-chain migration, but more like Move code upgrade. So we still need an "old" vs "new" comparison. We cannot expect that all Move 2024 features are used correctly since the start given that there is not a great number of examples and docs related to it!

@miker83z Would you like to have a strict explanation like Levi mentioned? Especially: remove alpha version mentions, reformulate “migration” sense?

The description we have about the alpha version right now is ok! So, just reformulating the “migration” sense would be great!

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

lzpap
lzpap approved these changes Nov 13, 2024
View reviewed changes
Copy link
Member

@lzpap lzpap left a comment

Choose a reason for hiding this comment

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

Looks good, thanks @Dkwcs!

salaheldinsoliman
salaheldinsoliman reviewed Nov 13, 2024
View reviewed changes
Copy link
Contributor

@salaheldinsoliman salaheldinsoliman left a comment

Choose a reason for hiding this comment

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

Looks great! Some small Lints though

docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/introducing-move-2024.mdx

This document highlights some new features to try out and shows how to use them in your existing modules.

:::info
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we remove this info?
We have a feedback form included in each page of the docs, which automatically opens Github issues

Copy link
Contributor Author

@Dkwcs Dkwcs Nov 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Maybe we can keep Discord link?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can keep both, it doesn't hurt to give the users options.

docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/introducing-move-2024.mdx Show resolved Hide resolved
@lzpap @salaheldinsoliman
Apply suggestions from code review
c83f6e8 
Co-authored-by: salaheldinsoliman <[email protected]>
@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

lucas-tortora
lucas-tortora approved these changes Nov 13, 2024
View reviewed changes
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 article :) Just some comments as to text style

docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
docs/content/developer/advanced/introducing-move-2024.mdx Outdated Show resolved Hide resolved
Dkwcs and others added 21 commits November 13, 2024 16:53
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
38dccf2 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
d155de7 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
167bfc9 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
0b07b1b 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
c06bf5d 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
1dad29f 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
fe112b8 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
7869771 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
5a9c20e 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
0569755 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
a8a415c 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
cecf82b 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
451dc11 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
c1a619b 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
2772ecb 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
60b4e29 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
c52cd53 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
c52f654 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
abc1487 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs @lucas-tortora
Update docs/content/developer/advanced/introducing-move-2024.mdx
27b7f0f 
Co-authored-by: Lucas Tortora <[email protected]>
@Dkwcs
Fix text style(according to review comments)
cef9021
@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@lzpap lzpap merged commit d558b1e into develop Nov 13, 2024
31 of 32 checks passed
@lzpap lzpap deleted the sc-platform/ensure-Move-2024-and-Enums-documented branch November 13, 2024 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucas-tortora lucas-tortora lucas-tortora approved these changes

@salaheldinsoliman salaheldinsoliman salaheldinsoliman left review comments

@nonast nonast nonast left review comments

@lzpap lzpap lzpap approved these changes

@miker83z miker83z miker83z approved these changes

@valeriyr valeriyr Awaiting requested review from valeriyr

Assignees

@Dkwcs Dkwcs

@nonast nonast

Labels
documentation Improvements or additions to documentation vm-language Issues related to the VM & Language Team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[docs/move] Ensure Move 2024 and Enums are documented
6 participants
@Dkwcs @lzpap @miker83z @nonast @salaheldinsoliman @lucas-tortora