Skip to content

chore(docs): Solidity Learning Journey#4081

Merged
signorecello merged 19 commits intomasterfrom
zpedro/docs_lj
Jan 23, 2024
Merged

chore(docs): Solidity Learning Journey#4081
signorecello merged 19 commits intomasterfrom
zpedro/docs_lj

Conversation

@signorecello
Copy link
Copy Markdown
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
Copy Markdown
Contributor Author

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 18, 2024

@critesjosh
Copy link
Copy Markdown
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
Copy Markdown
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 and others added 2 commits January 22, 2024 10:30
@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
@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