Skip to content
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
wants to merge 27 commits into
base: main
Choose a base branch
from

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Nov 6, 2024

PR Checklist

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 is next/, 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:

  • Set up a Starlight site on a /next base URI
  • Create visual theme based on the existing brand colors
    • Port over the top-of-page animated logo
    • Port over the footer
    • Polish dark mode
    • Fix all auto-detectable accessibility issues
  • Separate existing headings and content into structured content
    • Reorder cli.mdx to match actual CLI output and sections
    • Add new interfaces/third-party page to match reporters/third-party
  • Update inline links to use the new structure
  • Update block quotes and other emphasized lines to admonitions
  • Add build script to generate sponsors data

After this is merged, we'll want to:

  1. Share it out for early interest & feedback
  2. Wait a while
  3. Deploy this on mochajs.org/next, with existing routes such as /api not being impacted
  4. Eventually switch this site to be the root page, with the old one under something like /old
    • Needed: JavaScript-based redirects for old # headings
    • Needed: Migrate the existing /api old JSDoc & docdash generation (or an equivalent)
    • Needed: Migrate the existing /examples/test page from the old docs

Later-on out-of-scope items that I think would be good:

  • Add a nicer preview / thumbnail
  • Fill in missing content
    • Move content from the wiki that should be here, such as third-party interfaces and reporters
    • Move mochajs/mocha/tree/main/example/config to the examples repo
  • Refresh Editor Plugins
  • Revamp the sponsors & backers lists to be more based on total donations
  • Revamp the content to be more clear, organized, and up-to-date with modern practices
    • Stop discouraging arrow functions in features/arrow-functions
  • Run an accessibility audit on link titles and image descriptions
  • Update screenshots
  • Update out-of-date information
    • Editor plugins, reporters
    • Screenshots of browsers
    • Third-party examples
  • Update version notices older than 8.0.0 (see existing issue)
  • Onboard /api to something new like TypeDoc
  • 404 page

Astro/Starlight issues (pending https://discord.com/channels/830184174198718474/1070481941863878697/1303801639785726045):

  • To be filed: Suggest ComponentProps<typeof Default> in overriding components
  • To be filed: Asides that are empty: don't add extra vertical interior margin

💖

Copy link

netlify bot commented Nov 6, 2024

Deploy Preview for mocha-docs-next ready!

Name Link
🔨 Latest commit 83353e3
🔍 Latest deploy log https://app.netlify.com/sites/mocha-docs-next/deploys/672cd432a8e454000822f26a
😎 Deploy Preview https://deploy-preview-5246--mocha-docs-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review November 6, 2024 19:25
@JoshuaKGoldberg JoshuaKGoldberg requested a review from a team November 6, 2024 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

📝 Docs: Overhaul website generation 📝 Docs: Standardize slogan as something without "simple"
1 participant