Thanks for considering a contribution. This project exists because Mendix developers share what they've learned in production, and every new guide or improvement helps the community.
- New guides covering Mendix topics not yet in the repo
- Improvements to existing guides — corrections, updated version info, better examples
- Real-world patterns you've used in production that others would benefit from
- Fork the repository
- Create a branch for your changes
- Write or edit your guide
- Submit a pull request with a clear description of what you changed and why
- Be practical. Include real configurations, code snippets, and examples. Abstract advice without concrete implementation isn't as useful.
- Be specific. Mention Mendix version numbers, known limitations, and gotchas. If something only applies to Mendix 10+, say so.
- Be direct. Write like you're explaining something to a colleague, not writing a textbook. Skip the filler.
If you're writing a new guide, follow the structure used by existing guides:
- Start with a clear
# Title - Add a brief description of what the guide covers and who it's for
- Include a Table of Contents with anchor links
- Use
##for major sections and###for subsections - End with practical examples or checklists where it makes sense
Place new guides in an appropriately named directory with a README.md, or add them to an existing directory if they fit.
Every guide should include breadcrumb navigation at the top:
[Home](../README.md) > **Your Section Name**
---And a footer at the bottom:
---
<div align="center">
**[Back to Home](../README.md)**
</div>- Marketing copy or content that reads like a sales pitch
- Guides that are just a restatement of official Mendix documentation without added value
- Content with PII, real credentials, or internal infrastructure details
Open an issue if you're unsure whether a topic fits or want to discuss the direction of a guide before writing it.