Skip to content

docs: add serie 1 chapter 1 of guided tutorials #266

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

s3bc40
Copy link
Contributor

@s3bc40 s3bc40 commented Jul 19, 2025

Description

This pull request introduces updates to the documentation, focusing on enabling ZKsync support and adding comprehensive tutorials for the Moccasin framework. The most significant changes include enabling ZKsync by default, adding a guided tutorial section for Moccasin, and creating detailed instructions for setting up ZKsync tools and projects.

  • New feature
  • Bug fix
  • Code refactor
  • Documentation
  • Other

Related Issue(s)

Checklist

  • I have removed any unrelated changes from this PR
  • I’ve run just test-all and ensured all tests pass
  • I’ve run just typecheck and resolved any typing issues
  • I’ve run just format to auto-format code

If any new functionality was added or changed, were tests included?

  • Yes, tests were added/updated
  • No, and I understand this will likely delay review/merge
  • N/A

Platform/Environment Tested

  • Linux/macOS
  • Dev Container (VSCode)
  • Other:

Notes for Reviewers

  • Added a new section for guided Moccasin tutorials in docs/source/toctree.rst and created a corresponding index file (docs/source/tutorials/index.rst) with an introduction to the tutorials and important notes for users. [1] [2]
  • Introduced a new tutorial series, "Series 1: Moccasin Core & ZKsync," with a step-by-step guide for setting up ZKsync tools and initializing Moccasin projects. This includes:

Final Notes

1_2_setup_moccasin_project.rst not done but will be later!

funny frogs

s3bc40 added 2 commits July 19, 2025 17:59
- First part of the series of guided tutorials for Moccasin.

Includes the first two sections of the first chapter, which covers setting up ZKsync tools and setting up a Moccasin project.

Second chapter will be added later.
@PatrickAlphaC
Copy link
Member

I love the frogs btw

@s3bc40
Copy link
Contributor Author

s3bc40 commented Jul 21, 2025

I love the frogs btw

I think we should keep this convention introduced by @PROWLERx15 💯

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.

2 participants