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

Ethdoc plugin #3475

Merged
merged 59 commits into from
Mar 23, 2023
Merged

Ethdoc plugin #3475

merged 59 commits into from
Mar 23, 2023

Conversation

joeizang
Copy link
Collaborator

@joeizang joeizang commented Mar 1, 2023

This PR generates documentation from compiled contracts using openzeplin docgen libraries @bunsenstraat adapted for remix ide. Follow these steps to test:

  • Checkout this branch locally
  • using the NX VsCode plugin, run both docviewer and remixdocgen plugins
  • add local iframe plugins for both remixdocgen (sidepanel on localhost:6003) and docviewer (mainPanel on localhost:7003).
  • compile any contract and switch to docgen plugin and click on generate (note that this sidepanel UI is very temporary for now) and the docviewer will display the generated documentation.

The docviewer handles the generated md files and displays them. You will find the docs inside the docs folder in File Explorer

fix #3462

@joeizang joeizang self-assigned this Mar 1, 2023
@netlify
Copy link

netlify bot commented Mar 1, 2023

Deploy Preview for remixproject ready!

Name Link
🔨 Latest commit 8b56fe7
🔍 Latest deploy log https://app.netlify.com/sites/remixproject/deploys/641c0273e5b8ef00084142dd
😎 Deploy Preview https://deploy-preview-3475--remixproject.netlify.app/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@joeizang joeizang closed this Mar 2, 2023
@joeizang joeizang reopened this Mar 2, 2023
@joeizang joeizang added the WIP label Mar 2, 2023
@joeizang joeizang force-pushed the ethdoc-plugin branch 11 times, most recently from 0b79b64 to 9874d3f Compare March 9, 2023 17:06
@joeizang joeizang marked this pull request as ready for review March 14, 2023 18:34
@yann300
Copy link
Contributor

yann300 commented Mar 15, 2023

please update the naming of the plugin (the folder name too), this should be doc-viewer and doc-gen

@joeizang joeizang requested review from Aniket-Engg and LianaHus and removed request for bunsenstraat and yann300 March 15, 2023 12:17
@joeizang joeizang removed the WIP label Mar 15, 2023
@Aniket-Engg Aniket-Engg merged commit 5c9f5df into master Mar 23, 2023
@Aniket-Engg Aniket-Engg deleted the ethdoc-plugin branch March 23, 2023 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-to-review PR ready to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move ethdoc/ethdoc viewer under remix umbrella and improve UX
8 participants