docs: start doc/ — QC checks and the module map (WIP) - #38
Draft
ZheningHuang wants to merge 1 commit into
Draft
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Draft — actively being written. Opening it early so the structure is visible and reviewable in pieces.
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.
doc/modules.mddoc/QC/collision_check.mddoc/QC/door_open.mddoc/Tools/*.mdcollision_check.mdThe most complete one. It records the parts that are decisions rather than implementation details:
floatingandoutside_roomare reported but do not fail, because a floating object means a missing support andoutside_roommeans the scan's wall loop is wrong. Neither is repairable by the collision resolver, so failing on them would block every publish on an upstream problem.Lowercase
doc/Deliberate. This filesystem is case-insensitive (
core.ignorecase=true), so a strayDoc/looks identical locally but is a separate path on Linux CI. Nothing is tracked upstream yet, so fixing the case now costs nothing; after two directories exist it is a real cleanup.Not here
doc/QC/support_check.md— it belongs with the code it describes, in #37.Known gaps
collision_check.mdstill 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. Needs correcting.Tools/files are empty.