-
-
Notifications
You must be signed in to change notification settings - Fork 9.7k
Open
Description
Proposal
Add guidance on avoiding speciesist language to Docusaurus's documentation, both for the project's own docs and as a recommendation for users building documentation sites.
Docusaurus is uniquely positioned: it's not just a project with docs — it's a documentation framework used by thousands of projects. Writing guidance from Docusaurus carries outsized influence on technical documentation across the ecosystem.
Examples and alternatives
| Speciesist term | More precise alternative | Why |
|---|---|---|
| Canary deployment/release | Progressive rollout | Describes the actual process, not a reference to sending canaries into mines to die |
| Dogfooding | Self-hosting, internal testing | Immediately understood by any reader, including non-native speakers |
| Cattle vs. pets | Ephemeral vs. persistent | More technically precise |
| Kill (a process) | Terminate, stop | Already widely adopted |
Note: Docusaurus uses "canary" for its pre-release channel and has a _dogfooding directory. This isn't a call to rename everything overnight — it's proposing to document preferred direction and adopt alternatives in new writing.
Why this matters
- Precision: Animal-derived idioms require cultural knowledge to decode. "Progressive rollout" is clearer than "canary deployment."
- Internationalization: Docusaurus has strong i18n support. "Dogfooding" has no intuitive meaning in any language. Precise terms translate and localize better.
- Inclusivity: These phrases normalize violence toward animals, just as master/slave normalized other hierarchies.
Precedent
- master → main (GitHub, GitLab, Bitbucket)
- master/slave → primary/replica (MySQL, PostgreSQL, Redis)
- whitelist/blacklist → allowlist/blocklist
- Inclusive Naming Initiative
- Google developer documentation inclusive language guide
What this could look like
- A section in CONTRIBUTING.md recommending precise technical terms over animal-derived idioms
- A documentation writing guide with inclusive language recommendations
- Gradual adoption in new writing going forward
Reference: Open-Paws/speciesist-language-scanner provides automated detection tooling.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels