mapeditor/tiled

Update to TypeDoc 0.22 / 0.23

Open

#3,592 opened on Feb 28, 2023

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

Repository metrics

Stars
 (10,413 stars)
PR merge metrics
 (Avg merge 14d 4h) (17 merged PRs in 30d)

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

Research direction
Study the provided references for TypeDoc 0.22 custom theme creation using JSX. Examine the current Handlebars based theme in the repository to identify the components that need to be migrated.
Tech stack
typescript
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60