Update to TypeDoc 0.22 / 0.23
Open
Nobody has claimed this yet.
help wanted
website
- Dominant language
- C++
- Stars
- 12.9k
- Forks
- 2k
- Avg merge
- 4h 27m
- Merged PRs (30d)
- 8
Description
Currently the scripting documentation on the website is still driven by TypeDoc 0.21, since its theming is based on customizing Handlebars files. To update to TypeDoc 0.22 and beyond, we need to redo the customization using a JSX theme.
References:
- https://typedoc.org/guides/changelog/#v0.22.0-(2021-09-10)
- https://github.com/TypeStrong/typedoc/blob/v0.22.0/internal-docs/custom-themes.md
- https://github.com/Gerrit0/typedoc-custom-theme-demo
TypeDoc 0.21 custom theme:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing TypeDoc 0.21 custom theme history in gh-pages/docs/typedoc_theme and read the linked TypeDoc custom-themes guide and demo. Replace the Handlebars-based customization with a JSX theme compatible with TypeDoc 0.22 and beyond, then verify that the website's scripting documentation is generated correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- handlebars
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100