docs2 icon indicating copy to clipboard operation
docs2 copied to clipboard

:memo: Creating a draft for upcoming cross-contract tutorial

Open LuffySama-Dev opened this issue 1 year ago • 10 comments

Hi @barriebyron,

I am creating this PR for #776 . We can keep this in draft. Today I have tested the code and added the basic layout. I will keep on committing to this PR until the tutorial is ready.

Thank You 😃

LuffySama-Dev avatar Feb 21 '24 15:02 LuffySama-Dev

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

Name Status Preview Comments Updated (UTC)
docs2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 7, 2024 3:36pm

vercel[bot] avatar Feb 21 '24 15:02 vercel[bot]

@LuffySama-Dev is attempting to deploy a commit to the o1labs Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar Feb 21 '24 15:02 vercel[bot]

Hi @barriebyron ,

I have started adding content in 12-cross-contract-calls.mdx file. The build is successful but when I am trying to run it locally using npm run dev I am can't see this tutorial.

Does it needs to be updated some other place in order for it to be visible ?

Tomorrow I will push the code on top of which tutorial can be updated further.

Thank You 😃

LuffySama-Dev avatar Feb 24 '24 14:02 LuffySama-Dev

Hi @barriebyron ,

The final change to the tutorial is added. Can you please help to review and let me know if any changes are required ?

  • Also, do we need to have comments in code file and tutorial ?

Thank you 😃

LuffySama-Dev avatar Feb 26 '24 02:02 LuffySama-Dev

Hi @barriebyron ,

The tutorial draft is ready and code is audited with latest version of o1js and zkApp cli. Can you please help to check and let me know if any changes are required ?

Thank You 😃

LuffySama-Dev avatar Feb 27 '24 12:02 LuffySama-Dev

To add the tutorial to the sidebars, see https://github.com/o1-labs/docs2/wiki/Markdown-Syntax#sidebar and then a preview of the doc will be available at https://docs2-git-fork-luffysama-dev-issue776luffy-minadocs.vercel.app/

I think you know already you can build the docs locally per https://github.com/o1-labs/docs2/blob/main/README.md#how-to-see-your-local-doc-updates-during-development

I am learning more about how to test the code... let me help you get the preview working and then I'll test it! thank you

barriebyron avatar Feb 28 '24 16:02 barriebyron

To add the tutorial to the sidebars, see https://github.com/o1-labs/docs2/wiki/Markdown-Syntax#sidebar and then a preview of the doc will be available at https://docs2-git-fork-luffysama-dev-issue776luffy-minadocs.vercel.app/

I think you know already you can build the docs locally per https://github.com/o1-labs/docs2/blob/main/README.md#how-to-see-your-local-doc-updates-during-development

I am learning more about how to test the code... let me help you get the preview working and then I'll test it! thank you

Awesome!! Thank you so much ... Will commit these changes by EOD.

Great !! Let me know if you need help with testing code 😃.

Thank you so much 🙌🏻

LuffySama-Dev avatar Feb 28 '24 17:02 LuffySama-Dev

Hi @barriebyron ,

I have pushed the changes and added he tutorial in sidebar. Tested it locally and build is success and can see it.

The links to code in tutorial won't work as of now as this PR is not merged into main branch yet. (Code is also part of this PR)

Can you please help to check if any other changes are required ?

Thank You so much ❤️

LuffySama-Dev avatar Feb 29 '24 00:02 LuffySama-Dev

Hi @barriebyron ,

The final change to the tutorial is added. Can you please help to review and let me know if any changes are required ?

  • Also, do we need to have comments in code file and tutorial ?

Thank you 😃

@LuffySama-Dev Yes, please, let's add code comments in the smart contract and include those comments in the code shown in the doc. Comments are the pathway to sharing knowledge.

barriebyron avatar Mar 06 '24 16:03 barriebyron

Hi @barriebyron , The final change to the tutorial is added. Can you please help to review and let me know if any changes are required ?

  • Also, do we need to have comments in code file and tutorial ?

Thank you 😃

@LuffySama-Dev Yes, please, let's add code comments in the smart contract and include those comments in the code shown in the doc. Comments are the pathway to sharing knowledge.

on it 🫡

LuffySama-Dev avatar Mar 06 '24 16:03 LuffySama-Dev