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

Upgrade to typedoc v0.20 #234

Merged
merged 6 commits into from
May 15, 2021
Merged

Upgrade to typedoc v0.20 #234

merged 6 commits into from
May 15, 2021

Conversation

donmccurdy
Copy link
Owner

Fixes #182.

Several good things here: Typedoc will now let us document the extensions and lib packages, not just core, on the same site. And the CLI seems to be a bit faster and nicer. But, there are some breaking things to work through here:

Maybe also have a look at the @category tag usage, it might get rid of the need to manually write the TOC here. TypeStrong/typedoc#564.

@donmccurdy donmccurdy added feature New enhancement or request documentation labels Apr 20, 2021
@donmccurdy donmccurdy added this to the v0.10 milestone Apr 20, 2021
@donmccurdy
Copy link
Owner Author

A few more thoughts:

  • Should probably start by just upgrading, and add the other packages to the docs in a separate PR.
  • When that happens, links to many existing pages will change, so we may want Vercel to handle the redirects.

@donmccurdy donmccurdy modified the milestones: v0.10, v0.11 Apr 26, 2021
@donmccurdy
Copy link
Owner Author

Waiting for TypeStrong/typedoc#1580.

@donmccurdy donmccurdy merged commit 93a0d1c into main May 15, 2021
@donmccurdy donmccurdy deleted the feat-typedoc-0.20 branch May 15, 2021 03:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code health documentation feature New enhancement or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update to Typedoc v0.20
1 participant