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
faqlabel, but none matched my issue. - I want to provide a PR to resolve this
Overview
Right now, there are three user-facing first-party resources containing Mocha documentation separate from this repo:
- https://mochajs.org: the primary docs, maintained by our team
- https://github.com/mochajs/mocha/wiki: a corollary to the primary docs, freely editable by anybody
- https://github.com/mochajs/mocha-examples: various examples of how to use+ integrate Mocha, maintained by our team
IMO it's weird to have two places to find the primary docs (the site & the wiki). Now that we're overhauling the primary docs (#5207 -> #5246), I think they're a lot better suited for including the ancillary information typically put in the wiki.
The wiki is also super old and outdated. Other than a kind edit by by @mark-wiemer it hasn't been touched since 2022, when it was receiving fewer than a half dozen edits per year on average back through 2020.
Proposal: once the docs overhaul is shipped to users, let's:
- Copy any relevant info from the wiki over to the docs site & examples repo
- Change all wiki pages to just point to the updated locations for that info
- Freeze the wiki and deprecate using it
Note that we don't know what community resources point to the wiki, so we can't delete it or rename pages. Those URLs need to stick around.
Additional Info
Sparked by #5247: which is one example of the quirks you can get from working with the old GitHub wiki features.
We noted in #5027 that we didn't intend to overhaul any major resources such as the wiki. But that was a year ago, and we've learned about in the maintenance cycle since. Intentions can change over time!