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

docs(documentation): added guides and improved overall docs #1853

Merged
merged 1 commit into from
Oct 17, 2024

Conversation

crisgarner
Copy link
Collaborator

Description

This PR started as a simple navigation improvement but ended with a bunch of improvements to our docs, heavily inspired by the documentation of great projects like Uniswap, EigenLayer, Semaphore, and others. The most notable changes are:

  • Condensed redundant information in a single space.
  • Moved some files to a more related category.
  • Added more visibility to sections that beginners might try to check first.
  • Created Guides section with multiple guides.
  • Created a Getting Started page.
  • Added some small UI improvements to the code blocks.

Confirmation

Copy link

vercel bot commented Oct 11, 2024

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

Name Status Preview Updated (UTC)
maci-website ✅ Ready (Inspect) Visit Preview Oct 17, 2024 3:05pm

@crisgarner
Copy link
Collaborator Author

There is a bunch of stuff that we can do to improve the docs, and this PR was getting big so wanted to start with this, next tasks that might be important to fix that I will make some issues are:

  • Improve the Use Cases Section
  • Improve some guides (Integrating)
  • Some links are pointing to solidity docs that don't exist
  • Remove more content that isn't required or merge it with other sections.

Copy link
Collaborator

@kittybest kittybest left a comment

Choose a reason for hiding this comment

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

Thanks for this huge PR! Just left some comments

@crisgarner crisgarner force-pushed the docs/improve-navigation branch 2 times, most recently from 1518139 to 5b7d61e Compare October 17, 2024 02:55
@crisgarner
Copy link
Collaborator Author

crisgarner commented Oct 17, 2024

Added more updates based on feedback from @kittybest @aguzmant103 @ctrlc03.

  • Improved frontend guide
  • Removed old content and moved around some files to a more visible part.
  • Added notes on circuits compilations.

Copy link
Collaborator

@kittybest kittybest left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks!
And in the comment, you mentioned several possible improvements, I agree to move them to another issues and deal with them in another PR(s).

@crisgarner crisgarner merged commit a0a1309 into dev Oct 17, 2024
22 checks passed
@crisgarner crisgarner deleted the docs/improve-navigation branch October 17, 2024 20:13
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