Skip to content

Docs: migrate programmatic usage to docs and development content to DEVELOPMENT.md #5464

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Docs: migrate programmatic usage to docs and development content to DEVELOPMENT.md #5464

wants to merge 2 commits into from
+190 −0

Conversation

@TG199
Copy link
Contributor

@TG199 TG199 commented Sep 12, 2025 •
edited
Loading

PR Checklist

Overview

Migrate 2 developer-focused wiki pages to docs and development,md file:

  • Using Mocha programmatically
  • Developing mocha

Part of #5248 wiki migration effort.

@TG199
docs: migrate developer-focused wiki pages to main documentation
89f7c0d 
Migrate 2 developer-focused wiki pages to both docs systems:
- Using Mocha programmatically
- Developing mocha

Part of mochajs#5248 wiki migration effort.

Signed-off-by: Kelechi Ebiri <[email protected]>
JoshuaKGoldberg
JoshuaKGoldberg reviewed Sep 25, 2025
View reviewed changes
docs-next/src/content/docs/explainers/developing-mocha.mdx Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 We already have a .github/DEVELOPMENT.md in the repository. I would think we can leave development stuff like this out of the public website.

WDYT @mochajs/committers?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, let's repurpose this PR to just edit that development.md file, we don't need any docs here on the main website, that should stay focused to user-facing content

JoshuaKGoldberg
JoshuaKGoldberg reviewed Sep 25, 2025
View reviewed changes
docs-next/src/content/docs/explainers/developing-mocha.mdx Outdated

$ cd node_modules/
$ mv mocha/ mocha.save
$ git clone https://github.com/visionmedia/mocha.git
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aside: I forgot this used to be under visionmedia. What a throwback! 😄

@JoshuaKGoldberg JoshuaKGoldberg added the status: in triage a maintainer should (re-)triage (review) this issue label Sep 30, 2025
@mark-wiemer mark-wiemer added status: waiting for author waiting on response from OP or other posters - more information needed and removed status: in triage a maintainer should (re-)triage (review) this issue labels Oct 1, 2025
@JoshuaKGoldberg
Copy link
Member

👋 just checking in @TG199, are you waiting on us for anything?

@TG199
Copy link
Contributor Author

TG199 commented Oct 29, 2025

Hi @mark-wiemer @JoshuaKGoldberg!
I see #5497 was opened requesting updates to DEVELOPMENT.md. Should I repurpose this PR to address that issue as well, or keep this focused solely on the wiki migration aspect?

@JoshuaKGoldberg
Copy link
Member

Let's keep this one focused.

@TG199
Copy link
Contributor Author

TG199 commented Oct 31, 2025

Okay

mark-wiemer
mark-wiemer requested changes Nov 1, 2025
View reviewed changes
Copy link
Member

@mark-wiemer mark-wiemer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Migrate 2 developer-focused wiki pages to both docs systems:

  • Using Mocha programmatically
  • Developing mocha

Using Mocha programmatically also applies to users, not just Mocha devs. Developing Mocha is the only Mocha-dev-focused content I've seen in the wiki, and that should go to DEVELOPMENT.md as mentioned earlier.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Nov 2, 2025 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@codecov
Copy link

codecov bot commented Nov 2, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@6654704). Learn more about missing BASE report.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #5464   +/-   ##
=======================================
  Coverage        ?   93.73%           
=======================================
  Files           ?       57           
  Lines           ?     4390           
  Branches        ?      849           
=======================================
  Hits            ?     4115           
  Misses          ?      275           
  Partials        ?        0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@TG199 TG199 changed the title Docs: migrate developer-focused wiki pages to main documentation Docs: migrate programmatic usage to docs and development content to DEVELOPMENT.md Nov 2, 2025
@TG199
docs: split wiki content appropriately
9efcd3e 
- Move 'Developing mocha' wiki content to .github/DEVELOPMENT.md
- Keep 'Using Mocha programmatically' in public docs
@TG199 TG199 force-pushed the migrate-wiki-developer-guides branch from 01b7fd2 to 9efcd3e Compare November 3, 2025 00:48
@TG199 TG199 requested a review from mark-wiemer November 3, 2025 00:58
@TG199 TG199 mentioned this pull request Nov 3, 2025
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JoshuaKGoldberg JoshuaKGoldberg JoshuaKGoldberg left review comments

@mark-wiemer mark-wiemer Awaiting requested review from mark-wiemer

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

status: waiting for author waiting on response from OP or other posters - more information needed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@TG199 @JoshuaKGoldberg @mark-wiemer