Update hand-written documentation in docs/. Use when adding features, changing APIs, or modifying user-facing behavior that needs documentation updates. Covers physics, scripting, components, editor, and all other guide pages.
Update the hand-written guides in docs/ to reflect code changes.
NEVER touch docs/api/ — that directory is auto-generated from XML doc comments by a CI workflow on each release. Do not edit, regenerate, or reference its contents as a source of truth for writing guides.
Read the code changes (new files, modified files, git diff) to understand:
The hand-written docs live in docs/. Use this mapping to find the right file:
| Topic | File |
|---|
| Rigidbodies, colliders, raycasting, triggers, character controller | docs/physics.md |
| Custom components, lifecycle, game assemblies | docs/scripting.md |
| Built-in component reference (properties tables) | docs/components.md |
| Editor panels, shortcuts, workflows | docs/editor-guide.md |
| Audio playback, buses, attenuation | docs/audio.md |
| Lighting, materials, post-processing | docs/rendering.md |
| UI system | docs/ui.md |
| Prefabs, entity references | docs/prefabs.md |
| Export pipeline, packaging | docs/exporting.md |
| Project settings files | docs/project-settings.md |
| First-time setup | docs/getting-started.md |
| Common issues | docs/troubleshooting.md |
| Docs index / table of contents | docs/README.md |
| Future plans | docs/roadmaps/*.md |
If a change spans multiple topics, update all relevant files.
Read the target doc file before editing. Understand:
Follow the existing style of the document. General conventions:
using statements when showing API usage for the first time in a section| Property | Default | Description | format| Field | Type | Description | format## for major topics, ### for subtopics within themIf a new guide file was created, or if an existing guide's scope changed significantly, update the tables in docs/README.md to reflect it.
docs/ were edited (not docs/api/)docs/README.md index is up to date if guides were added/renamed