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

chore(docs): Solidity Learning Journey #4081

Merged
merged 19 commits into from
Jan 23, 2024
Merged

chore(docs): Solidity Learning Journey #4081

merged 19 commits into from
Jan 23, 2024

Conversation

signorecello
Copy link
Contributor

Description

As part of DevRel's work on Learning Journey's, this PR improves them.

Problem*

Relates to this DevRel issue

Summary*

  • Puts the "Creating a Project" and "Project Breakdown" pages inside a dropdown called "Hello Noir"
  • Refactors the Solidity Verifier How-To to include a Remix IDE verification example with images and more context
  • Refactors the Noir landing page to incorporate a "Noir Basics" role, improves UI, adds a header image and a tabs feature, and favouring links to awesome-noir instead of hardcoded library examples
  • Refactors the Homepage with buttons to immediately start the Solidity Learning journey

Additional Context

Here's the Solidity Learning Journey. For now only 3 levels deep, assuming the user would have enough autonomy to proceed after the 3rd page. This will be reassessed in the future.

Screenshot 2024-01-18 at 10 29 44

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 18, 2024
@signorecello signorecello requested a review from a team January 18, 2024 10:30
@signorecello
Copy link
Contributor Author

Could use @jzaki's Solidity knowledge to double-check the guide :)

Copy link
Contributor

github-actions bot commented Jan 18, 2024

docs/docs/getting_started/hello_noir/index.md Show resolved Hide resolved
docs/docs/how_to/how-to-solidity-verifier.md Outdated Show resolved Hide resolved
docs/docs/how_to/how-to-solidity-verifier.md Show resolved Hide resolved
docs/docs/index.mdx Outdated Show resolved Hide resolved
docs/docs/index.mdx Outdated Show resolved Hide resolved
docs/docs/index.mdx Show resolved Hide resolved
@critesjosh
Copy link
Contributor

Did you have trouble updating to Docusaurus 3? I tried to update the Aztec docs but ran into a ton of parsing errors due to the update to MDX v3. Mainly relating to invalid character in names for autogenerated docs. Did you encounter anything like that?

@signorecello
Copy link
Contributor Author

I updated to that version some weeks/months ago actually... And yes MDX was breaking due to some chars not being escaped (like <, {, etc)

Some other minor things as well. I also had a problem with a webpack bug, that should be fixed in docusaurus 3.1.0 so I'll eventually update to that one at least

@signorecello signorecello added this pull request to the merge queue Jan 23, 2024
Merged via the queue into master with commit 09d1d5c Jan 23, 2024
31 checks passed
@signorecello signorecello deleted the zpedro/docs_lj branch January 23, 2024 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants