Skip to content

📝 Docs: Migrate /api docs or an equivalent from the old site to the new one #5309

Open
@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Documentation Request Checklist

Overview

Right now, https://mochajs.org/api is an auto-generated API resource built on @mochajs/mocha-docdash - a fork of docdash. Users expect API docs for Mocha, so we'll need to include them in the new website.

I think we have three options:

  • Finding a newer equivalent that integrates with Astro/Starlight
  • Un-fork and work with docdash to get whatever features we need moved into docdash core
  • Keep the existing @mochajs/mocha-docdash fork & system

Those options are sorted in order of my personal preference 😄. Docdash hasn't had a push in 2 years and it's not exactly actively maintained. Projects like Typedoc are a good bit more supported. starlight-typedoc looks pretty great.

Proposal: let's move to starlight-typedoc?

Additional Info

No response

Metadata

Metadata

Labels

area: documentationanything involving docs or mochajs.orgcore-teamissues which must be handled by Mocha's core teamstatus: accepting prsMocha can use your help with this one!

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions