📝 Documentation #659
Draft
📝 Documentation #659
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, I'd like to work on ERC20, ERC721 and WETH. |
* updated sidebar w/ placeholders * fixed broken link for libPRNG
* added ERC20 draft * changed bullet point * added example usage section * added gas benchmarks and Api reference section * fixed formatting * added documentation up to totalSupply(), committing changes so I can see how it looks like * fixed grammar and standardized structure * added documentation for balanceOf and allowance * added documentation for the approve function * added documentation for transfer * added revert condition for transfer function * standardize * Added documentation on nonces * added documentation for permit * added documentation for DOMAIN_SEPERATOR * added section for events * fixed events table format * fixed small typo * added benchmarks for ERC20
|
Wow, this is sick! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
For the sidebar, we want to have the following structure:
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:
forge fmt?forge snapshot?forge test?Pull requests with an incomplete checklist will be thrown out.