Skip to content

docs: doc/ — the module map, the QC gates, and the agent tools - #38

Merged
ZheningHuang merged 6 commits into
mainfrom
doc/qc-and-modules
Sep 9, 2026
Merged

docs: doc/ — the module map, the QC gates, and the agent tools#38
ZheningHuang merged 6 commits into
mainfrom
doc/qc-and-modules

Conversation

@ZheningHuang

@ZheningHuang ZheningHuang commented Aug 17, 2026

Copy link
Copy Markdown
Member

Somewhere to write down what the pipeline is made of and what each QC gate actually promises, rather than leaving it spread across module docstrings.

file what it covers
doc/modules.md the ten modules the system is built from, and the rule that every update ties to one
doc/QC/collision_check.md entities, rules, the deterministic function, what a failure hands the repair step
doc/QC/supporting_relationship.md the other half of sim-readiness — every object rests on something, and stays there
doc/Tools/threed_gen.md the procedural / TRELLIS split and the router that chooses per object
doc/Tools/rendering_and_compare.md render | photo pairing, the three target layers, and the two honest-render invariants
doc/Tools/image_selection.md select_views — which frames a tool looks at, and why the agent never guesses one
doc/Tools/fetch_material.md Poly Haven fetch + LAB recolour, and why the search ranking is fussier than it looks
doc/Sim-Ready-intergration/ metadata notes; MuJoCo still to write

What these pages are for

Each one records the parts that are decisions rather than implementation details — the things a reader cannot recover from the code:

  • collision_check.md — which findings fail the gate and which don't (floating and outside_room are reported but never fail: one means a missing support object, the other means the scan's wall loop is wrong, and neither is repairable here); why contact comes from the raw triangles but distance from a convex decomposition; and that a failure hands the fixer an exact metric vector, not a description.
  • supporting_relationship.md — that touching is not the same as supported. A lamp on the last centimetre of a table corner passes any gap test and topples on frame 1, so the check is contact plus centre-of-mass over the shared footprint. no_supporter only reports, because this stage can move an object but cannot invent the table that should have been under it.
  • rendering_and_compare.md — the two invariants that keep a render honest: recompile when Room.py is stale, and repack any procedural object whose object.py is newer than its packed GLB. Without the second, editing an object and re-rendering shows the old one, and the agent concludes its edit did nothing.

Figures

assets/doc/ carries the per-tool figures from the project blog post, plus two stills from its object-reconstruction videos showing the same three panels down each route — procedural/articulated and TRELLIS. Provenance is recorded in assets/doc/README.md.

Also here

example-scans had been committed as a mode-160000 gitlink with no .gitmodules, so a fresh clone got an empty, unfixable directory. Untracked and ignored — the scans are cloned separately.

Still open

  • doc/Sim-Ready-intergration/Mujoco.md is empty.
  • collision_check.md says wall fixtures are "fixed to the wall". In the current code they are in no collision body at all — Panda-1 has five that are simply absent from the model.

WIP. Writes down what the pipeline is made of and what each QC gate promises,
in one place instead of across module docstrings.

  modules.md            the eight modules the system is built from
  QC/collision_check.md the collision gate: entities, rules, the deterministic
                        function, and what a failure hands the repair step
  QC/door_open.md       a note, not yet a check
  Tools/*.md            placeholders, one per agent tool — structure only

Lowercase `doc/` deliberately: this filesystem is case-insensitive
(`core.ignorecase=true`), so a stray `Doc/` looks identical locally but is a
separate path on Linux CI. Fixing the case now is cheaper than after two
directories exist upstream.

`QC/support_check.md` is not here — it belongs with the code it describes,
in the support-check PR.
@ZheningHuang ZheningHuang added the work in progress Work in progress label Aug 17, 2026
ZheningHuang and others added 4 commits September 9, 2026 12:52
It was committed as a mode-160000 submodule pointer with no .gitmodules, so a
fresh clone got an empty, unfixable example-scans/ directory. The scans are
cloned separately (github.com/LiteReality/example-scans), so ignore the path
instead.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MzyqwdyphzzWVUeMd5qgNK
@ZheningHuang ZheningHuang changed the title docs: start doc/ — QC checks and the module map (WIP) docs: doc/ — the module map, the QC gates, and the agent tools Sep 9, 2026
@ZheningHuang
ZheningHuang marked this pull request as ready for review September 9, 2026 12:33
@ZheningHuang
ZheningHuang merged commit a9d9457 into main Sep 9, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

work in progress Work in progress

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant