Contribute to the docs

Welcome. Doc Detective is better because of contributors like you. Whether you’re fixing a typo, adding an example, or writing comprehensive tutorials, your contribution matters.

Good enough is better than perfect

You don’t need to be a technical writer or documentation expert to contribute. If you see something that could be clearer, more accurate, or more helpful, you can improve it. We value accurate information over elegant prose. If you know something that should be documented, share it.

Before you start

Code of Conduct: Be respectful and constructive in all interactions. Everyone is volunteering their time, including both you and the maintainers.
CLA Requirement: Before code or documentation contributions can be merged, you need to sign the contributor license agreement. This makes sure that your contributions are properly licensed and maintains the project’s open-source status.
Questions?: Join our Discord server to ask questions or discuss your contribution ideas.

Choose your contribution path

Pick the path that matches your available time and what you want to accomplish:

Quick changes (2-10 minutes)

Perfect for typos, broken links, or small clarity improvements.

👉 Quick changes guide

Examples

Fix a typo or grammar issue
Update an outdated screenshot
Fix a broken link
Clarify confusing wording

Standard changes (10-30 minutes)

Great for adding missing information or examples.

👉 Standard changes guide

Examples

Add missing steps to a tutorial
Provide a code example
Add a troubleshooting tip
Create a FAQ entry

Substantial changes (30+ minutes)

For major documentation projects, new pages, or new features.

👉 Substantial changes guide

Examples

Document a new feature
Write a complete tutorial
Restructure existing documentation
Create comprehensive reference documentation

How contributions are reviewed

We aim to provide

Initial response: Within 2 business days
Complete review: Within 5 business days for standard contributions
Expedited review: Within 24 hours for critical fixes (security issues, broken functionality)

What we check for

✅ Information is technically accurate ✅ Content serves the intended user journey ✅ Automated style checks pass ✅ Links and references work correctly

What we DON’T block on

⛔ Perfect prose or elegant writing ⛔ Comprehensive coverage of edge cases ⛔ Advanced formatting or design elements

If your PR doesn’t get a response within our SLA, feel free to respectfully ping the reviewers or post in Discord.

Recognition

All contributors are acknowledged in our release notes and on our contributors page. Thank you for making Doc Detective better.

Other ways to contribute

Report issues

Found a problem in the documentation? Open an issue on GitHub. Include:

What’s wrong or missing
Which page you’re referring to
What you expected to see

Support the project

If you can’t contribute time, you can support Doc Detective financially or spread the word about the project.

Next steps

Ready to contribute? Choose your path above and get started.