Docs: Improve readme and autogenerate natspec doc #29
Conversation
This file contains hidden or 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
Current config auto-generates markdown in docs/ from the solidity natspec in contracts/OffsetHelper*: npx hardhat docgen
This description is in the contract's natspec and not be duplicated
0xmichalis
approved these changes
Jun 14, 2022
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.
This PR:
yarn docupdates the markdown doc in./docs/.yarn docas a Github action step to test that documentation generation is working.Points 1. and 2. in this PR fixes #27.
Note: Currently the autogenerated doc is checked-in in the
./docs/folder for convenience. We could consider generating html/publishing this to this repo's Github pages in a Github action in order to avoid the documentation becoming out of date.