Important

This repository is archived. All code and functionality has been merged into doc-detective/doc-detective.

Doc Detective docs

This is the repository for the Doc Detective documentation. This repository contains all the content used to build the docs site.

Doc Detective is an open-source documentation testing framework that makes it easy to keep your docs accurate and up-to-date.

Quick start

# Clone the repository
git clone https://github.com/doc-detective/docs
cd docs

# Install dependencies
npm run setup

# Start the development server
npm run dev

Visit http://localhost:3000 to see your changes live.

Fixes or contributions

Did you find a typo, a broken link, or another item with an obvious quick fix?

If you can see what the problem is, and you know how to fix it, then you can make a pull request with the change and contribute to the docs repo yourself.

You can also see existing issues or create a new one to alert us of the problem.

Want to make a larger contribution? Please see CONTRIBUTING.md first!

Test the docs

Doc Detective tests its own documentation! Learn about our testing approach:

• Run tests: npm run test
• Write tests: See our Testing Guide
• Test files: Look for .spec.json files throughout the docs

Questions or ideas?

• Docs: Browse the documentation
• Issues: Report bugs or request features
• Discord: Join our community

License

Documentation prose is licensed under the Creative Commons Attribution 4.0 International (CC-BY) license. Code samples and other files are licensed under the MIT license.