Reorganize physical backend documentation - #7098
Conversation
Define authoritative homes for backend concepts, setup, procedural guides, and generated API reference. Record the page-level moves and deletions needed to eliminate duplicated and fast-drifting content.
Apply the repository's 2026 copyright and BSD-3-Clause SPDX header to the backend documentation design artifact.
Greptile SummaryThe PR reorganizes physical-backend documentation into concepts, task-oriented how-to guides, and developer guidance, while synchronizing backend-related user skills.
Confidence Score: 4/5The documentation reorganization should not merge until legacy backend-page URLs redirect to their replacement content. Internal references resolve, but moving and deleting published Sphinx pages without aliases causes existing bookmarks, search results, and external links to return 404 responses. Files Needing Attention: docs/source/how-to/native_physics_api/index.rst and the documentation redirect configuration Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart LR
Legacy[Legacy backend pages] --> Concepts[Concepts: selection, architecture, identities, solvers]
Legacy --> HowTo[How-to: preparation, tuning, transfer, native APIs]
Legacy --> Developer[Developer guide: adding a backend]
Concepts --> Skills[Backend user skills]
HowTo --> Skills
Reviews (1): Last reviewed commit: "Clarify physical backend concepts" | Re-trigger Greptile |
| Direct Physics Engine API Access | ||
| ================================ | ||
| .. _native-physics-api: | ||
|
|
There was a problem hiding this comment.
There was a problem hiding this comment.
Isaac Lab Review Bot
The documentation reorganization is coherent, but the PR also commits a hidden design-plan artifact under docs/superpowers/, contrary to the repository rule against committing generated plans or agent artifacts.
- Design and architecture: The content is sensibly divided among Concepts, How-to, and Developer Guide pages, with legacy backend material routed through updated toctrees and references. Before merge, remove the committed
docs/superpowers/specs/2026-08-13-physical-backend-docs-reorganization-design.mdplan and its dedicated Sphinx exclusion. - API: No public runtime API changes are introduced. The documentation compatibility surface includes preserved labels for the moved MJWarp and Kamino pages and updated references to the new backend architecture, physics backend, solver differences, and native API locations.
- Implementation: The moved and deleted documentation paths are generally integrated consistently, including skill references and the renamed native-physics API tree. The remaining issue is the 208-line implementation plan committed beneath
docs/superpowers/and hidden viaexclude_patterns; it pins transient implementation context and should not remain as an unbuilt repository artifact.
Minor fixes needed. Posted 1 actionable finding inline.
Automated review; human maintainers own approval decisions.
| SPDX-License-Identifier: BSD-3-Clause | ||
| --> | ||
|
|
||
| # Physical Backend Documentation Reorganization |
There was a problem hiding this comment.
🟡 Warning · Design Architecture — Committed plan artifact excluded from docs build
This 208-line design/plan document is an agent artifact, and docs/conf.py adds superpowers/** to exclude_patterns solely so Sphinx ignores it. Repository guidelines state not to commit generated plans, scratch files, or agent artifacts. It pins a base commit SHA and a page inventory, so it will silently drift from the pages it describes while living permanently under docs/. Remove the file and the accompanying exclusion.
There was a problem hiding this comment.
Why is this folder name with underscore while others are with dash?
| @@ -0,0 +1,208 @@ | |||
| <!-- | |||
There was a problem hiding this comment.
were these intended to be added?
Description
Reorganizes the physical backend documentation by content type:
No runtime behavior, public API, dependency, or installation behavior changes are included.
Type of change
Screenshots
Not applicable; this is an information-architecture and prose update.
Release backport
developValidation
Checklist