Using AI Tools for Documentation
Introduction
Contributors may use AI tools such as large language models and writing assistants to draft or improve documentation. However, these tools must be treated as writing aids, like spell-checkers or linters, and not as authoritative sources.
Contributor Responsibility
If you use AI tools, before contributing, you must:
- Review and verify the accuracy of all AI-assisted content.
- Ensure the content does not infringe on third-party copyrights.
- Remove hallucinated content or unsupported claims.
- Confirm that the AI tool's terms do not impose restrictions inconsistent with Mendix's contributors license agreement.
AI output must be treated as unverified draft material.
Maintainer Discretion
Maintainers may request clarification, edits, or removal of AI-assisted content if concerns arise regarding accuracy, licensing, or quality.
Using AI Assistants
This repository is configured for use with Claude Code, an AI-powered coding assistant. There is also GitHub Copilot customization for contributors who use it.
Claude Code Configuration
The default AWS profile name is my-sandbox. If your AWS sandbox profile has a different name, create .claude/settings.local.json in the repo root and include the following lines:
{
"env": {
"AWS_PROFILE": "your-sandbox-name"
}
}This file is gitignored and will override the shared settings.
.claude/settings.json or other files in the .claude/ directory for personal configuration. These files contain shared configuration for all contributors.
Custom Skills
This repository includes custom Claude Code skills optimized for documentation work:
/proofread- Checks spelling, grammar, punctuation, and basic Markdown formatting/polish- Improves clarity, readability, and word choice without changing meaning/enhance- Performs comprehensive editing including reorganization, restructuring, and stronger phrasing/review- Analyzes documentation and generates suggestions for improvements/add- Adds new content to an existing page while preserving original structure
These skills are available to all contributors using Claude Code with this repository.