onflow / flow

Flow is a fast, secure, and developer-friendly blockchain built to support the next generation of games, apps, and the digital assets that power them 🌊
https://onflow.org
Apache License 2.0
358 stars 163 forks source link

Update & improve Cadence onboarding tutorials and best practices docs #339

Open psiemens opened 3 years ago

psiemens commented 3 years ago

Context

The Cadence tutorials (e.g. https://docs.onflow.org/cadence/tutorial/01-first-steps) were originally written almost a year ago. Cadence has changed a lot since then! It's time to update them to be demonstrative of modern Cadence.

Definition of Done

The following should be addressed for each tutorial listed below:

Tutorials:

joshuahannan commented 3 years ago

@10thfloor Where are the automated tests for the tutorials located? Probably would be good to include something in this ticket for making sure those get updated with the latest code too and are still passing.

@robmyers Do you feel good enough about the kitty items marketplace contract that you could use that as the marketplace tutorial instead of what we currently have?

turbolent commented 3 years ago

Two things were reported that I can think off:

alilloig commented 2 years ago

Luckily this is right place to discuss this, right now we have the ft tutorial placed after the nft tutorial, is that intended to be that way?

joshuahannan commented 2 years ago

@alilloig yes that was intentional after the recent tutorials audit

alilloig commented 2 years ago

When we update the two remaining tutorials it will be nice to update the links (e.g. https://docs.onflow.org/cadence/tutorial/07-marketplace-setup/ is actually the 5th tutorial now, not the 7th)

joshuahannan commented 2 years ago

Actually, the link is correct. The title and sidebar for the tutorials is wrong there. Marketplace setup should be the 7th tutorial, marketplace the 8th tutorial, composable the 9th, and voting the 10th. Can you update those also?

alilloig commented 2 years ago

Yeah that's true, I'll update it! I'm assuming I only need to update the title field on the .mdx files, that is correct?

joshuahannan commented 2 years ago

You'll also need to update the gatsby-config file in the onflow/flow repo