chore(docs): rename docs-next to docs#5770
Conversation
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Pull request overview
This PR completes the transition from the legacy documentation site to Astro Starlight by renaming the docs-next/ directory to docs/. Since the Astro Starlight site is now the primary and only documentation for Mocha, the "-next" suffix is no longer needed.
Changes:
- Renamed
docs-next/directory todocs/across the entire codebase - Moved
_data/supporters.jsfrom legacy docs to the new docs directory - Added
debugas a devDependency in docs/package.json since supporters.js requires it
Reviewed changes
Copilot reviewed 9 out of 121 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Updated root script to reference docs instead of docs-next |
| eslint.config.js | Updated ignore pattern for docs directory |
| .github/workflows/mocha.yml | Removed duplicate docs-next/** path trigger |
| README.md | Updated logo image path to reference docs/ |
| docs/README.md | Updated directory reference in instructions |
| docs/package.json | Updated package name, scripts, and added debug dependency |
| docs/package-lock.json | Reflected package name change and new dependency |
| docs/netlify.toml | Updated publish path to docs/dist/ |
| docs/_data/supporters.js | Reformatted code and updated comments to remove references to dual docs system |
| docs/* (new files) | All Astro documentation site files properly added |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Thanks @sudip-kumar-prasad :) we do already have a Copilot PR for this but I'm sure that one's gotten stale too. As you can see, this PR is also already stable. Unfortunately this rename isn't top priority right now, so we may be merging a lot of different things that repeatedly make this PR stale. I'll see if I can check this out this weekend and close it out though, appreciate your patience! |
Fixes mochajs#5676. Replaces the legacy `docs` directory with the new `docs-next` Astro Starlight documentation site. Updates all references in GitHub workflows, npm scripts, and ESLint configuration to point to the new location.
a571b76 to
df10412
Compare
Netlify looks for netlify.toml at the repository root by default. The file was previously at docs-next/netlify.toml (with Netlify configured to use that subdirectory as base), but after renaming docs-next/ to docs/, the config was only present at docs/netlify.toml, which Netlify cannot discover automatically. This adds a root-level netlify.toml that points the build command and publish dir to the new docs/ location.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5770 +/- ##
==========================================
+ Coverage 88.73% 89.70% +0.96%
==========================================
Files 66 64 -2
Lines 4742 4691 -51
Branches 976 976
==========================================
Hits 4208 4208
+ Misses 534 483 -51 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
mark-wiemer
left a comment
There was a problem hiding this comment.
Approved under the condition I can go into Netlify and fixup the base path. I think we maintainers generally agree that we minimize root-level files as much as possible, it just looks so messy.
|
Changed Netlify to use |
|
Thank you! |
PR Checklist
docs-next/todocs/#5676status: accepting prsOverview
This PR addresses issue #5676 by renaming the
docs-nextdirectory todocs. Since the Astro Starlight site has become the primary documentation for Mocha, the "next" suffix is no longer necessary. The legacydocsfolder has been replaced.Changes Made:
docs/_data/supporters.jsto the new docs directory as it's still required for generating the sponsors JSON.docs/repository withdocs-next/.docs-nextacross the codebase:package.jsonscripts at the root and inside the docs directory..github/workflows/mocha.ymlpath triggers.eslint.config.jsto correct the linting target.README.mdandnetlify.tomlfile paths.debugas adevDependencyindocs/package.jsonsincesupporters.jsrelies on it, fixing local ESLint errors.Related Issues
Fixes #5676