mapeditor/tiled

Update to TypeDoc 0.22 / 0.23

Open

#3592 opened on Feb 28, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (10,413 stars) (1,708 forks)batch import
help wantedwebsite

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:

TypeDoc 0.21 custom theme:

Contributor guide

Tech stack
typescriptnodejs
Domain
documentation
Issue type
chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript basicsTypeDoc themingJSX/React basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Review the TypeDoc migration guide from v0.21 to v0.22, focusing on custom theming changes. Study the demo repository (Gerrit0/typedoc custom theme demo) to understand JSX theme structure. Examine the existing Handlebars based theme in the gh pages branch of Tiled (mapeditor/tiled/gh pages/docs/typedoc theme). Implement a new JSX theme and integrate it with the current documentation build process.