Are you an LLM? You can read better optimized documentation at /contributing.md for this page in Markdown format
Contribute
The Mincemeat documentation is open source. We welcome corrections, clarifications, and new pages from anyone who uses Mincemeat or wants to make the docs better.
This section explains how we write, how to run the site locally, and how to send a pull request that can merge quickly.
Where to start
| If you want to | Start here |
|---|---|
| Understand how we write | Style guide |
| Know which fields every page must have | Content model |
| Run the site on your machine | Local development |
| Review your change before opening a PR | Pull request checklist |
| Confirm sensitive data is not exposed | Security and privacy |
Two quick promises
- Public. Everything you push to this repository is public the moment it lands. Read the security and privacy page before your first pull request.
- Useful first. A short, accurate page beats a long, vague one. Prefer the smallest change that fixes the reader's problem.
Licensing
| What | License |
|---|---|
| Site code, theme, scripts, build config | MIT |
| Documentation content, prose, tables, diagrams | CC BY 4.0 |
| Trademarks and logos | Property of their respective owners. Not granted under either license. |
By contributing, you agree your prose and content contributions are licensed under CC BY 4.0 and your code contributions are licensed under MIT.
Reporting security issues
Do not open a public issue for security or sensitive-data concerns. Use the private channels in SECURITY.md.
