statebot icon indicating copy to clipboard operation
statebot copied to clipboard

TypeDoc clobbering sub-module docs that were previously generated

Open shuckster opened this issue 2 years ago • 0 comments

No idea when this was introduced or how to fix. Notes for future self:

Steps to reproduce:

git checkout issues/3
pnpm install --frozen-lockfile
pnpm run build:docs

Output:

warning Failed to resolve {@link assert.assertRoute} in index.Statebot.name with declaration references. This link will break in v0.24.
warning Failed to resolve {@link assert.assertRoute} in index.TStatebotFsm.name with declaration references. This link will break in v0.24.
warning Failed to resolve link to "assert.assertRoute" in comment for index.Statebot.Statebot.name
warning Failed to resolve link to "assert.assertRoute" in comment for index.TStatebotFsm.name.name

Also, documentation for the following sub-modules all get deleted (although they still appear in the generated documentation index file.)

  • statebot/assert
  • statebot/hooks/react
  • statebot/hooks/mithril

Likely something wrong with:

  • TypeDoc/JSDoc comments in .d.ts
  • tsconfig.json
  • package.json sub-modules config

shuckster avatar Aug 15 '22 21:08 shuckster