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

TypeDoc clobbering sub-module docs that were previously generated #3

Open
shuckster opened this issue Aug 15, 2022 · 0 comments
Open
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@shuckster
Copy link
Owner

shuckster commented Aug 15, 2022

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 shuckster self-assigned this Aug 15, 2022
@shuckster shuckster added bug Something isn't working documentation Improvements or additions to documentation labels Sep 27, 2022
@shuckster shuckster added the help wanted Extra attention is needed label Mar 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant