Fill documentation gaps identified by a CARLA documentation audit, following the project's writing style. Work through one category at a time, assess which findings deserve entries, update source files, and report changes and skipped findings.
Writes the missing CARLA documentation that the audit found — Python API entries in PythonAPI/docs/*.yml, sensors in ref_sensors.md, catalogue actors, broken links and nav entries, and the images, animations and diagrams the pages need — one category at a time, in CARLA's house style. Use when the user asks to "document this feature", "write the docs for X", "fix the audit findings", "update the doc images / screenshots / catalogue pictures", or names a category such as "the Python API part".
Review the instructions the agent will receive before you install.
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/…andreferences/…are relative to the directory holding this SKILL.md, not to the user's working directory.
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.
| category | audit signal | files it edits | status |
|---|---|---|---|
python-api | binding, stale | PythonAPI/docs/*.yml, then regenerate | references/python_api.md |
changelog | changelog | CHANGELOG.md | references/changelog.md |
sensors | sensor | Docs/ref_sensors.md | references/sensors.md |
catalogue | catalogue | Docs/catalogue_*.md | not written yet |
links | link | the page holding the link | not written yet |
nav | orphan | mkdocs.yml | not written yet |
images | UE4-era or missing images | Docs/img/<page>/, Docs/img/catalogue/ | references/images.md |
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.
Docs/python_api.md is generated. Editing it directly is lost on the
next regeneration, and the audit will not notice.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.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.Edited source files, and a report naming what was written, what was skipped and why. Nothing is committed.
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Add a message type to CARLA's native ROS 2 interface. Create its C++ data structure, serialization code for transmission, type identity hash, registration, and tests, with Docker-based hash calculation and build checks.
Extend CARLA’s native ROS 2 interface to publish sensor data or receive vehicle commands. Covers topic implementation, registration, data connections, and verification, plus adding middleware, the communication layer used to exchange messages.
Summarize ScenarioRunner results to see which scenarios passed and which checks failed. Compare runs before and after changes, or analyze recorded driving to produce measurements and plots of vehicle distance and deviation from the lane center.
Checks a local CARLA checkout for missing API documentation, outdated references, broken links, and pages absent from navigation. Produces a grouped Markdown report without building the project or running the simulator.
Read and display CARLA object bounding boxes, then project them onto a camera image as 2D rectangles. Export an annotated PNG and box coordinates in JSON for object detection annotation work.
Builds CARLA's ue4-dev branch on Linux, producing the Unreal Engine 4.26 editor, server modules, and an installed Python client package. Fetches required content, optionally compiles native ROS 2 support, and verifies the build against a source-built server.