-
-
Notifications
You must be signed in to change notification settings - Fork 3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add new website using Astro Starlight #5246
Conversation
✅ Deploy Preview for mocha-docs-next ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty darn good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much for the thorough review @mark-wiemer!
For all the suggestions to Astro/infra areas and introduced issues: 👍 agreed, applied.
For the clarity, proofreading, and other existing content changes suggestions: I propose we tackle those in >1 followup PR. Some of them are more subjective and might take some time for discussion. I think it'd be valuable to get this PR merged in the interim. WDYT?
Co-authored-by: Mark Wiemer <7833360+mark-wiemer@users.noreply.github.com>
Co-authored-by: Mark Wiemer <7833360+mark-wiemer@users.noreply.github.com>
PR Checklist
status: accepting prs
Overview
Creates a new website under
docs-next/
using Astro Starlight. It contains roughly the same documentation as before, just split up into a more modern website with a navigation sidebar and a table-of-contents on each page. Its base route isnext/
, like https://mochajs.org/next.🌟 This is deployed to Netlify on: https://mocha-docs-next.netlify.app.
"Feature parity" tasks that I took for this PR:
/next
base URIinterfaces/third-party
page to matchreporters/third-party
After this is merged, we'll want to:
/api
not being impacted/old
#
headings/api
old JSDoc & docdash generation (or an equivalent)/examples/test
page from the old docsLater-on out-of-scope items that I think would be good:
/api
to something new like TypeDocAstro/Starlight issues (pending https://discord.com/channels/830184174198718474/1070481941863878697/1303801639785726045):
ComponentProps<typeof Default>
in overriding components💖