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

Tutorial dapp #197

Merged
merged 53 commits into from
Dec 8, 2023
Merged

Tutorial dapp #197

merged 53 commits into from
Dec 8, 2023

Conversation

zamrokk
Copy link
Contributor

@zamrokk zamrokk commented Dec 1, 2023

Add the 4 dapp tutorials of the Marigold learning page

@zamrokk zamrokk requested a review from a team as a code owner December 1, 2023 15:55
Copy link

vercel bot commented Dec 1, 2023

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

Name Status Preview Comments Updated (UTC)
docs-staging ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 8, 2023 3:04pm

Copy link

@onedebos onedebos left a comment

Choose a reason for hiding this comment

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

Hey Benjamin,

I can see that will be some issues with merging this and deploying to Vercel.

Can you take a look?

Copy link
Collaborator

@timothymcmackin timothymcmackin left a comment

Choose a reason for hiding this comment

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

The build is failing because the title field of the markdown files is not valid. Use quotes for the strings because they contain colons.

docs/tutorials/dapp/part-1.md Outdated Show resolved Hide resolved
docs/tutorials/dapp/part-2.md Outdated Show resolved Hide resolved
docs/tutorials/dapp/part-3.md Outdated Show resolved Hide resolved
docs/tutorials/dapp/part-4.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@timothymcmackin timothymcmackin left a comment

Choose a reason for hiding this comment

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

Also need to remove the "th" from the dates to make Docusaurus handle them correctly.

docs/tutorials/dapp/part-1.md Outdated Show resolved Hide resolved
docs/tutorials/dapp/part-2.md Outdated Show resolved Hide resolved
docs/tutorials/dapp/part-3.md Outdated Show resolved Hide resolved
docs/tutorials/dapp/part-4.md Outdated Show resolved Hide resolved
docs/tutorials.mdx Outdated Show resolved Hide resolved
docs/tutorials/dapp.md Outdated Show resolved Hide resolved
docs/tutorials/dapp/part-1.md Outdated Show resolved Hide resolved
docs/tutorials/dapp/part-2.md Outdated Show resolved Hide resolved
docs/tutorials/dapp/part-3.md Outdated Show resolved Hide resolved
docs/tutorials/dapp/part-3.md Outdated Show resolved Hide resolved
docs/tutorials/dapp/part-3.md Outdated Show resolved Hide resolved
docs/tutorials/dapp/part-3.md Outdated Show resolved Hide resolved
docs/tutorials/dapp/part-3.md Outdated Show resolved Hide resolved
docs/tutorials/dapp/part-2.md Outdated Show resolved Hide resolved
@timothymcmackin
Copy link
Collaborator

  • For accessibility, provide alt text for images within the link brackets ![alt text](/img/path/image.png)
  • Add the tutorial to the tutorialsSidebar in sidebars.js
  • Settle on capitalization for "dapp." I've been using "dApp."
  • We can add the completed application to https://github.com/trilitech/tutorial-applications with the others.
  • Instead of naming the folder training, how about pokeGame or something that won't conflict with the other "training" tutorials?
  • For links, consider linking to docs.tezos.com where possible instead of sending people elsewhere. In part 1, there are links that could go to https://docs.tezos.com/smart-contracts/entrypoints and https://docs.tezos.com/smart-contracts/data-types/complex-data-types#variants.
  • To make the tutorial easy to follow, I like to make everything that the user does a numbered step. The section in part 1 under "write the poke function" has a lot of things that the user does that aren't steps, so it might get confusing. That's just how I've been trying to do the other tutorials.
  • Consistency: Start bulleted lists with a capital letter and end sentences with a period.
  • Indents: it would be easier to follow if the contents of a numbered step were indented so the things that were part of the step were farther to the right than the number. (see attached screencap)
  • Don't include a space before a colon.
  • I will enable mermaid diagrams for you; the diagrams do not appear properly.
  • This is a long enough tutorial that it should be in the intermediate section in tutorials.mdx.

Screenshot 2023-12-01 at 1 37 33 PM

zamrokk and others added 7 commits December 4, 2023 11:14
thanks

Co-authored-by: Tim McMackin <[email protected]>
thanks

Co-authored-by: Tim McMackin <[email protected]>
thanks

Co-authored-by: Tim McMackin <[email protected]>
thanks

Co-authored-by: Tim McMackin <[email protected]>
thanks

Co-authored-by: Tim McMackin <[email protected]>
thanks

Co-authored-by: Tim McMackin <[email protected]>
thanks

Co-authored-by: Tim McMackin <[email protected]>
weird duplication

Co-authored-by: Tim McMackin <[email protected]>
@timothymcmackin timothymcmackin merged commit ee2cc43 into staging Dec 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants