-
-
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
Open
JoshuaKGoldberg
wants to merge
27
commits into
mochajs:main
Choose a base branch
from
JoshuaKGoldberg:docs-next
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for mocha-docs-next ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
4 tasks
This was referenced Nov 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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💖