Closed mcmire closed 4 months ago
Note that there are other TypeDoc-related considerations that we could address in this PR but do not need to:
publish-docs
GitHub workflow in the module template uses TypeDoc to generate document and publish it, using the build:docs
package script. We want to make sure that projects have this workflow too, but checking this effectively is tricky. We can check that the workflow file is present but how do we know that it's getting run? So we can either think about this either in a separate PR, or we can handle this in https://github.com/MetaMask/module-lint/issues/6.Stretch: possible starting point for verifying that workflow is running: https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs
In this ticket we are not checking the workflow. See Elliot's comment.
We want to make sure that for a given project:
typedoc
as a dev dependency, and the versions match the same dev dependencies as in the module template.typedoc.json
, and the content of this file matches the same as in the module template.build:docs
package script as in the module template.