carla-simulator/carla/document-carla-feature

Document a CARLA feature

The writing half of the documentation programme. `audit-carla-docs` decides what is missing and writes Docs/audit_carla_docs.md; this skill writes it.

Paths. scripts/… and references/… are relative to the directory

holding this SKILL.md, not to the user's working directory.

One category at a time

The audit's signals are independent, and so is the work. Each category below touches its own files, so one person can take one category, or several agents can run all of them at once without colliding. Never work two categories in one pass — the rules differ and the review gets muddled.

Instructions

Progress:
- [ ] Step 1: Check prerequisites (bash scripts/check_env.sh)
- [ ] Step 2: Pick ONE category and read its reference in full
- [ ] Step 3: Read the matching section of Docs/audit_carla_docs.md
- [ ] Step 4: Triage — not every finding should be documented
- [ ] Step 5: Write the entries, following references/style.md
- [ ] Step 6: Remove what no longer exists, checking first that it was not renamed
- [ ] Step 7: Verify, and report what you skipped and why

Step 4 is not optional. The audit reports what it sees, not what deserves an entry; it has no way to tell a public API from binding plumbing. Each reference lists the exemptions for its category. Say in the report which findings you skipped and why — a silent skip reads as an oversight later.

Step 5 always obeys references/style.md, which is shared by every category: what a CARLA doc sentence says, and what it never says.

Step 6 removes, it does not deprecate. The reference describes what exists now, so a name the code no longer has is deleted outright — no tombstone and no "removed in" marker. Check it was not simply renamed first; most of the time it was, and then the entry moves instead of going.

Gotchas

• Docs/python_api.md is generated. Editing it directly is lost on the

next regeneration, and the audit will not notice.

• A finding is a candidate, not an instruction. Documenting an internal name

makes the reference worse, not better.

• Re-run the audit after a pass. The counts moving is the only evidence the

work landed.

• Pages written for UE4 / 0.9.x (restored or merged from older branches)

repeat the same stale facts. Grep for them and check each against the tree: make launch|import|PythonAPI|package|rebuild (now cmake --build Build/Release --target ... and Util/Tools/Import.py), UE4_ROOT (now CARLA_UNREAL_ENGINE_PATH), Unreal 4.26/4.27 and Visual Studio 2019 (5.8 and 2022), .egg files (wheels), PythonAPI/carla/source (PythonAPI/carla/src), boost::shared_ptr in bindings (std::shared_ptr), sensors overriding Tick (ASensor::Tick is final: override PostPhysTick) and Stream.Send (SerializeAndSend), CarlaUE4 paths and ../img/ links. Content paths move too: list the folder before writing one.

• Generators that need a server (bp_doc_gen.py, catalogue_doc_gen.py)

can be broken for months without anyone noticing; run them after editing them. ActorAttribute.as_str() only works on String attributes.

Output

Edited source files, and a report naming what was written, what was skipped and why. Nothing is committed.