layer-3 / smart

1 stars 3 forks source link

Migrate to `solidity-docgen@0.6.0` #43

Open nksazonov opened 1 year ago

nksazonov commented 1 year ago

solidity-docgen@0.6.0

This package version is still in beta, but yet is a full remastering of a package, which includes:

hardhat docgen task
docgen templates out of the box
support of helpers.ts files

Still, this migration will take some time due to changes of API of this package.

This will incorporate changes from other issues:

Use typescript docgen helpers file

replace helpers.js with corresponding helpers.ts
remove /docs/api/templates/helpers.js from .eslintignore
remove "exclude": ["./docs/api/templates/helpers.js"] from tsconfig.json

Include parent entity documentation in inherited one

create custom helper / find out how to use inheritdoc