-
Notifications
You must be signed in to change notification settings - Fork 270
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
Initial docs #142
Initial docs #142
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
Can you delete the API docs from the readmes, and also the FAQ, so we avoid that duplication?
I've changed this PR to go into a new branch until we publish the docs site, so that content remains available by browsing the repo until then.
I removed API & FAQ. |
Co-authored-by: Francisco Giordano <frangio.1@gmail.com>
Co-authored-by: Francisco Giordano <frangio.1@gmail.com>
Co-authored-by: Francisco Giordano <frangio.1@gmail.com>
Co-authored-by: Francisco Giordano <frangio.1@gmail.com>
Co-authored-by: Francisco Giordano <frangio.1@gmail.com>
Co-authored-by: Francisco Giordano <frangio.1@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should also have links to the API docs, but it's okay if we don't do that in this PR.
@frangio what will the name of the docs URL be? Is it https://docs.openzeppelin.com/upgradesplugins or something else? |
According to the current config the URL will be openzeppelin-upgrades/docs/antora.yml Lines 1 to 3 in 8f142a4
So the FAQ for example would be |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed the API links since they were pointing to the wrong page.
Thank you @abcoathup!
Initial docs based on READMEs and CLI and Lib docs.
Reference to
import "@openzeppelin/upgrades/contracts/Initializable.sol";
will need to be updated once OpenZeppelin/openzeppelin-contracts#2335 merged and released.network-files.adoc
may need reworking.Resolves #141