hardhat-docgen
hardhat-docgen copied to clipboard
Standalone mode?
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
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 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.