📝 Documentation

[Vectorized]

trafficstars

Description

For the sidebar, we want to have the following structure:

ACCOUNTS
- ERC4337
- ERC4337Factory
...
AUTH
- Ownable
- OwnableRoles
TOKENS
- ERC20 
...

Currently, it has the ERC721A docs. We will slowly replace the markdowns one by one to morph it.

Feel free to make a PR to this branch. Don't be shy. This is docs, so no risk of bugs.

Once we have around 30% of the stuff, we can consider merging into main.

Since it is too daunting to fill in all the markdowns at breakneck speed, we can simply create the planned markdowns first, and put a "Under Construction" placeholder.

Contributing

Since there may be multiple people working on the docs simultaneously, leave a comment on what you want to work on. This will prevent us from doing overlapping work.

Preview

Any pushes to this branch will be auto-deployed to:

https://vectorized.github.io/solady/

Motivation

Think of docs as a feature.

It elevates the quality of the repo all around.

It imbues an aura of prestige.

Documentation can include the nuances that are too bulky to be squeezed into the Natspec.

Making docs is one of the best way to get lots of green dots on your Github. Remember to make multiple PRs (e.g. one PR for one markdown) if you wanna farm docs.

Checklist

Ensure you completed all of the steps below before submitting your pull request:

• [x] Ran forge fmt?
• [x] Ran forge snapshot?
• [x] Ran forge test?

Pull requests with an incomplete checklist will be thrown out.

[ghost]

Hi, I'd like to work on ERC20, ERC721 and WETH.

[PraneshASP]

Wow, this is sick!