First Move Module Update 1 by tippi-fifestarr · Pull Request #826 · aptos-labs/developer-docs

tippi-fifestarr · 2025-02-24T18:20:43Z

Description

Updating this guide, added screenshots, steps, and example code. Designed for Web2 or Solidity developers to get a quick start in writing and publishing Move Modules

Checklist

If any existing pages were renamed or removed:
- Were redirects added to next.config.mjs?
- Did you update any relative links that pointed to the renamed / removed pages?
Do all Lints pass?
- Have you ran pnpm fmt?
- Have you ran pnpm lint?

… updated filenames in code blocks

vercel · 2025-02-24T18:20:49Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
developer-docs-nextra	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 26, 2025 5:19pm

hariria · 2025-02-24T20:09:25Z

apps/nextra/pages/en/build/guides/first-move-module.mdx

 # Your First Move Module

-This tutorial details how to compile, test, publish and interact with Move modules on the Aptos blockchain. The steps in summary are:
+The Aptos blockchain allows developers to write Turing complete smart contracts (called "modules") with the secure-by-design Move language. This means you can do all the blockchain things like sending money, but also write arbitrary code, even games. It all starts with the Move module. Once compiled and deployed with Aptos CLI, you can connect to a published move Module on Aptos like a public API via one of our [many Official SDKs](../sdks/).


Suggested change

The Aptos blockchain allows developers to write Turing complete smart contracts (called "modules") with the secure-by-design Move language. This means you can do all the blockchain things like sending money, but also write arbitrary code, even games. It all starts with the Move module. Once compiled and deployed with Aptos CLI, you can connect to a published move Module on Aptos like a public API via one of our [many Official SDKs](../sdks/).

The Aptos blockchain allows developers to write Turing complete smart contracts (called "modules") with the secure-by-design Move language. Smart contracts enable users to send money with the blockchain, but also write arbitrary code, even games!

I think the longer version helps explain the context the Move module is in. Just writing a contract without using the SDK to interact with it is incomplete, so I like mentioning it up front (even though it's beyond the scope of the tutorial).

We'll find a middle ground for the next iteration

@jmintuitive I respectfully disagree here, many folks write contracts without using the SDK to interact with it... and I don't see the SDK being used at all here in this tutorial so what's the relevence?

Also to be frank I think the writing here could be stronger — This means you can do all the blockchain things is vague and informal. I'd like the prose to be more concise and professional

We moved the SDK reference down and used the newer version with more professional concision

used the newer version with more professional concision

"The Aptos blockchain allows developers to write Turing complete smart contracts (called "modules") with the secure-by-design Move language. This means you can do all the blockchain things like sending money, but also write arbitrary code, even games. It all starts with the Move module. Once compiled and deployed with Aptos CLI, you can connect to a published move Module on Aptos like a public API via one of our many Official SDKs."

This still looks the same?

Should be in the newest commit de70beb

Mmm i don't think its in the commit de70beb... Unless I'm doing something wrong, it also looks the same in file view...

Thank you for your eagle eye and staying with this Andrew, it should now be good to go!

apps/nextra/pages/en/build/guides/first-move-module.mdx

Co-authored-by: Andrew Hariri <hariria@usc.edu>

tippi-fifestarr · 2025-02-24T22:43:45Z

@hariria Thank you for the feedback, I checked that removing .mdx works, did not know that, thanks! For the intro, we'd like to merge this as is and then work on the intro for the next draft

hariria · 2025-02-24T22:45:23Z

For the intro, we'd like to merge this as is and then work on the intro for the next draft

Out of curiosity, why not just change it in this PR?

tippi-fifestarr · 2025-02-24T22:58:36Z

@hariria just part of our internal workflow and backlog

hariria · 2025-02-24T23:14:38Z

??? 🤣 . These are getting merged to main immediately, idky we would postpone this change?

jmintuitive · 2025-02-25T15:11:58Z

??? 🤣 . These are getting merged to main immediately, idky we would postpone this change?

Imo the longer intro works well, and we're trying to get an updated version of this merged since it's been blocked for a while, and we want it as a link for in-person events (like Eth Denver this week).

The next version @tippi-fifestarr is talking about is based on user feedback (we did some user reviews of the guide) so that will impact the whole guide somewhat when we get to that revision (likely next week / the week after).

hariria

I like the general flow of the guide and some of the sections you added (i.e., defining move modules for the audience make a lot of sense), but I don't agree with some of the points raised, hopefully my comments provide some more color on my reasoning.

If we want to work on this over several passes that take place over multiple PRs I would suggest we make the appropriate fixes here before merging into main, since main is the production branch and everyone will see your changes immediately.

Another approach is to create branches on top of this branch, and merge into it. Then you can merge this base branch once everything on top of it has merged into this one.

hariria · 2025-02-25T16:30:26Z

apps/nextra/pages/en/build/guides/first-move-module.mdx

 # Your First Move Module

-This tutorial details how to compile, test, publish and interact with Move modules on the Aptos blockchain. The steps in summary are:
+The Aptos blockchain allows developers to write Turing complete smart contracts (called "modules") with the secure-by-design Move language. This means you can do all the blockchain things like sending money, but also write arbitrary code, even games. It all starts with the Move module. Once compiled and deployed with Aptos CLI, you can connect to a published move Module on Aptos like a public API via one of our [many Official SDKs](../sdks/).


@jmintuitive I respectfully disagree here, many folks write contracts without using the SDK to interact with it... and I don't see the SDK being used at all here in this tutorial so what's the relevence?

Also to be frank I think the writing here could be stronger — This means you can do all the blockchain things is vague and informal. I'd like the prose to be more concise and professional

apps/nextra/pages/en/build/guides/first-move-module.mdx

- Updated the opening paragraph for clarity and professionalism. - Moved SDK mention to the bottom of the tutorial. - Condensed the Setup section intro for readability. - Removed unnecessary dashes from headers and formatting. - Removed reference to Developer’s Journey blog. - Updated `aptos --version` to be copyable, while seperately showing the expected output.

tippi-fifestarr · 2025-02-26T17:21:32Z

Thank you again, Andrew!

tippi-fifestarr and others added 6 commits February 20, 2025 10:02

first draft of update

554b968

changed links to point to internal mdx files, added horizontal rules,…

10e0c6b

… updated filenames in code blocks

adding screenshots, still haven't built yet

4241f30

Merge branch 'aptos-labs:main' into move-draft

3e6aac7

finished checking draft, only missing Steps now

f8f025c

added Steps

945ca95

tippi-fifestarr requested review from gregnazario and hariria as code owners February 24, 2025 18:20

vercel bot deployed to Preview February 24, 2025 18:26 View deployment

ignored x.com so that the lychee will allow this to merge

2412d65

vercel bot deployed to Preview February 24, 2025 20:07 View deployment

hariria suggested changes Feb 24, 2025

View reviewed changes

tippi-fifestarr and others added 2 commits February 24, 2025 16:37

Update apps/nextra/pages/en/build/guides/first-move-module.mdx

533a5ea

Co-authored-by: Andrew Hariri <hariria@usc.edu>

Update apps/nextra/pages/en/build/guides/first-move-module.mdx

9d74812

Co-authored-by: Andrew Hariri <hariria@usc.edu>

vercel bot deployed to Preview February 24, 2025 22:44 View deployment

jmintuitive requested a review from hariria February 25, 2025 15:06

hariria suggested changes Feb 25, 2025

View reviewed changes

vercel bot deployed to Preview February 25, 2025 20:29 View deployment

tippi-fifestarr requested a review from hariria February 25, 2025 20:33

Merge branch 'main' into move-draft

93b7dd8

vercel bot deployed to Preview February 26, 2025 14:23 View deployment

updated intro

41c3bcf

hariria approved these changes Feb 26, 2025

View reviewed changes

vercel bot deployed to Preview February 26, 2025 17:19 View deployment

tippi-fifestarr merged commit 7fa89e2 into aptos-labs:main Feb 26, 2025
5 checks passed

Conversation

tippi-fifestarr commented Feb 24, 2025

Description

Checklist

Uh oh!

vercel bot commented Feb 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tippi-fifestarr commented Feb 24, 2025

Uh oh!

hariria commented Feb 24, 2025

Uh oh!

tippi-fifestarr commented Feb 24, 2025

Uh oh!

hariria commented Feb 24, 2025

Uh oh!

jmintuitive commented Feb 25, 2025

Uh oh!

hariria left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tippi-fifestarr commented Feb 26, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vercel bot commented Feb 24, 2025 •

edited

Loading