Skip to content

📝 Docs: Review recommended external tools #5445

@mark-wiemer

Description

@mark-wiemer

Documentation Request Checklist

Overview

Per #5442 we currently are recommending libraries in various places:

We should have guidelines around:

  • when to mention external tools
  • when to remove mentions of external tools
    • lack of compatibility with latest Mocha for X months?
    • tool officially deprecated?
    • tool claims it will only be compatible with Mocha version X and never Mocha version X+1?
    • any other reasons?
  • how to remove mentions of external tools
    • reach out to tool owner to confirm deprecation?
    • find a suitable replacement?
  • when to mark external tools as "recommended" vs just listing them
    • this one is very subjective 😬 maybe we never do this? if we list it, it should be good enough, and users can decide on their own?

Acceptance criteria for closing this issue:

  • all pages with recommendations identified
  • old recommendations reviewed and updated
    • removed during review
    • re-added if approved by Mocha maintainers following new guidelines
  • easily-discoverable callout "Suggest new tools on Discord" or similar. No formal template needed. Make it clear this isn't a sponsor thing, it's just based on whether the tool is useful and well-maintained

Additional Info

Mark's thoughts on current tools mentioned on wiki homepage

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: documentationanything involving docs or mochajs.orgcore-teamissues which must be handled by Mocha's core teamstatus: accepting prsMocha can use your help with this one!

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions