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

Standalone mode? #23

Open
KholdStare opened this issue Mar 10, 2023 · 2 comments
Open

Standalone mode? #23

KholdStare opened this issue Mar 10, 2023 · 2 comments
Labels
help wanted Extra attention is needed

Comments

@KholdStare
Copy link

Not everyone uses hardhat, and it's overly restrictive to bind it to one framework. It should be able to work standalone given solc compiler output

@ItsNickBarry
Copy link
Owner

This makes sense, but I only work with Hardhat, so I would need assistance from an external contributor. Not sure whether a truly "standalone" solution would be ideal, or if it would be better to maintain an adapter plugin for each framework. Open to suggestions.

If anyone wants to work on this, let me know and I'll create a new repository to hold the core logic while we convert this repository to work as a simple adapter.

@ItsNickBarry ItsNickBarry added the help wanted Extra attention is needed label Mar 10, 2023
@KholdStare
Copy link
Author

@ItsNickBarry Yes - having a "core" package that has no dependency on any framework makes sense. I think if the core just accepts devdoc and userdoc as inputs it should be enough. Basically everything from here on: https://github.com/ItsNickBarry/hardhat-docgen/blob/master/tasks/docgen.js#L46

From there the "hardhat adaptor" would just pass the devdoc/userdoc down to core which creates the actual documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants