|
| 1 | +--- |
| 2 | +title: "Using AI Tools for Documentation" |
| 3 | +url: /community-tools/contribute-to-mendix-docs/using-ai-tools/ |
| 4 | +weight: 30 |
| 5 | +description: "Guidelines for using AI tools when contributing to Mendix documentation." |
| 6 | +--- |
| 7 | + |
| 8 | +## Introduction |
| 9 | + |
| 10 | +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. |
| 11 | + |
| 12 | +## Contributor Responsibility |
| 13 | + |
| 14 | +If you use AI tools, before contributing, you must: |
| 15 | + |
| 16 | +* Review and verify the accuracy of all AI-assisted content. |
| 17 | +* Ensure the content does not infringe on third-party copyrights. |
| 18 | +* Remove hallucinated content or unsupported claims. |
| 19 | +* Confirm that the AI tool's terms do not impose restrictions inconsistent with Mendix's contributors license agreement. |
| 20 | + |
| 21 | +AI output must be treated as unverified draft material. |
| 22 | + |
| 23 | +## Maintainer Discretion |
| 24 | + |
| 25 | +Maintainers may request clarification, edits, or removal of AI-assisted content if concerns arise regarding accuracy, licensing, or quality. |
| 26 | + |
| 27 | +## Using AI Assistants |
| 28 | + |
| 29 | +This repository is configured for use with [Claude Code](https://code.claude.com/docs/en/vs-code), an AI-powered coding assistant. There is also GitHub Copilot customization for contributors who use it. |
| 30 | + |
| 31 | +### Claude Code Configuration |
| 32 | + |
| 33 | +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: |
| 34 | + |
| 35 | +```json |
| 36 | +{ |
| 37 | + "env": { |
| 38 | + "AWS_PROFILE": "your-sandbox-name" |
| 39 | + } |
| 40 | +} |
| 41 | +``` |
| 42 | + |
| 43 | +This file is gitignored and will override the shared settings. |
| 44 | + |
| 45 | +{{% alert color="warning" %}} |
| 46 | +Do not modify `.claude/settings.json` or other files in the `.claude/` directory for personal configuration. These files contain shared configuration for all contributors. |
| 47 | +{{% /alert %}} |
| 48 | + |
| 49 | +### Custom Skills |
| 50 | + |
| 51 | +This repository includes custom Claude Code skills optimized for documentation work: |
| 52 | + |
| 53 | +* `/proofread` - Checks spelling, grammar, punctuation, and basic Markdown formatting |
| 54 | +* `/polish` - Improves clarity, readability, and word choice without changing meaning |
| 55 | +* `/enhance` - Performs comprehensive editing including reorganization, restructuring, and stronger phrasing |
| 56 | +* `/review` - Analyzes documentation and generates suggestions for improvements |
| 57 | +* `/add` - Adds new content to an existing page while preserving original structure |
| 58 | + |
| 59 | +These skills are available to all contributors using Claude Code with this repository. |
| 60 | + |
| 61 | +## Read More |
| 62 | + |
| 63 | +* [Contributing to Mendix Docs](/community-tools/contribute-to-mendix-docs/) |
| 64 | +* [Documentation Writing Guidelines](/community-tools/documentation-guidelines/) |
0 commit comments