Contributing to Documentation
Help improve ACE documentation using our AI-assisted workflow
Our AI-Assisted Workflow
Writing technical documentation from scratch is time-consuming. We use AI to generate initial drafts, which human contributors then verify and refine. This approach lets us document more functions while maintaining accuracy.
Important
AI-generated documentation may contain errors. The human verification step is critical. Never trust AI output without checking the source code.
Verification Badges
Documentation was auto-parsed or AI-generated. May contain inaccuracies and should be compared against source code before use.
A contributor has manually checked this documentation against the source code. You can trust this information.
Step-by-Step Workflow
Find a Function
Browse the docs and find a function marked "Needs Verification" or one you use frequently and want to improve.
Click "Edit" then "🤖 Get AI Prompt"
On the function page, click Edit to enter edit mode, then click the "🤖 Get AI Prompt" button. This generates a comprehensive prompt with source code, usage examples, and context.
Use Your Preferred AI
Copy the prompt and paste it into Claude, ChatGPT, or any AI of your choice. The AI will respond with a JSON code block containing the documentation.
⚠️ Verify Against Source Code
This is the critical step. Compare the AI's response with the actual source code:
- Does the description accurately reflect what the function does?
- Are all parameters documented correctly?
- Are the types correct (Entity vs Player, table structure, etc.)?
- Did the AI invent any functionality that doesn't exist?
- Is the unused
_parameter documented as deprecated?
Import & Submit
Click "📥 Import AI Response" and paste the JSON. The form will auto-fill with the parsed data. Review the preview, make any corrections, and click Save. Your edit will be automatically verified.
💡 Tip: The import modal shows a preview of all parsed data before importing, so you can verify the JSON was parsed correctly.
AI System Prompt (Reference)
The "Get AI Prompt" feature already includes optimal instructions tailored to each function. But if you're setting up a custom workflow, here's the system prompt we recommend:
You are a technical documentation writer for Garry's Mod Lua addons, specifically for ACE (Armored Combat Extended).
Your task is to write accurate, helpful documentation for Lua functions based on their source code.
## Guidelines
1. Be concise but complete - describe WHAT the function does, not HOW
2. Use standard GMod/Lua types: string, number, boolean, table, Entity, Player, Vector, Angle
3. Mark optional parameters explicitly
4. Only document behavior evident from the source - don't invent functionality
5. If uncertain, use "likely" or "appears to"
6. Include practical examples when the purpose is clear
7. A parameter named `_` (underscore) means it is UNUSED/deprecated
## Output Format
Respond with ONLY a JSON code block:
```json
{
"description": "Brief description of what the function does",
"params": [{"name": "arg", "type": "type", "description": "...", "optional": false}],
"returns": [{"type": "type", "description": "..."}],
"examples": [{"code": "-- Lua example", "description": "What it shows"}]
}
```