-
-
Notifications
You must be signed in to change notification settings - Fork 3k
Open
Labels
area: documentationanything involving docs or mochajs.organything involving docs or mochajs.orgcore-teamissues which must be handled by Mocha's core teamissues which must be handled by Mocha's core teamstatus: blockedWaiting for something else to be resolvedWaiting for something else to be resolved
Description
Documentation Request Checklist
- I have read and agree to Mocha's Code of Conduct and Contributing Guidelines
- I have searched for related issues and issues with the
faq
label, but none matched my issue. - I want to provide a PR to resolve this
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
Assignees
Labels
area: documentationanything involving docs or mochajs.organything involving docs or mochajs.orgcore-teamissues which must be handled by Mocha's core teamissues which must be handled by Mocha's core teamstatus: blockedWaiting for something else to be resolvedWaiting for something else to be resolved