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: Consider moving wiki information into mocha-examples and the website #5248

Open
3 tasks done
JoshuaKGoldberg opened this issue Nov 9, 2024 · 1 comment
Open
3 tasks done
Labels
area: documentation anything involving docs or mochajs.org status: blocked Waiting for something else to be resolved status: in triage a maintainer should (re-)triage (review) this issue

Comments

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commented Nov 9, 2024

Documentation Request Checklist

Overview

Right now, there are three user-facing first-party resources containing Mocha documentation separate from this repo:

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:

  1. Copy any relevant info from the wiki over to the docs site & examples repo
  2. Change all wiki pages to just point to the updated locations for that info
  3. 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!

@JoshuaKGoldberg JoshuaKGoldberg added area: documentation anything involving docs or mochajs.org status: blocked Waiting for something else to be resolved status: in triage a maintainer should (re-)triage (review) this issue labels Nov 9, 2024
@mark-wiemer
Copy link
Contributor

One note: we can keep the pages, but maybe remove all content and instead just have each page link to the corresponding new doc page with a "please update your bookmarks" note. Alternatively, a simple banner at the top of each page saying "This wiki is deprecated and may be out of date. Please refer to (url) instead" would work :)

Thanks for opening this, I'm still determined to close #3104 :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation anything involving docs or mochajs.org status: blocked Waiting for something else to be resolved status: in triage a maintainer should (re-)triage (review) this issue
Projects
None yet
Development

No branches or pull requests

2 participants