Skip to content

Modular AirStack 9/9: standalone-snapshot docs, versioned Release Notes replace CHANGELOG - #396

Open
andrewjong wants to merge 8 commits into
rfc/s8-auditfrom
rfc/s9-docs-release-notes
Open

Modular AirStack 9/9: standalone-snapshot docs, versioned Release Notes replace CHANGELOG#396
andrewjong wants to merge 8 commits into
rfc/s8-auditfrom
rfc/s9-docs-release-notes

Conversation

@andrewjong

Copy link
Copy Markdown
Member

Stacked PR — merge the stack bottom-up with merge commits (squash-merging a lower PR orphans the commits every higher PR builds on). When the PR below merges, GitHub retargets this one to develop automatically. Each PR bumps VERSION (0.20.0-alpha.N), so check-version-increment passes at every level and each merge publishes images.

Stack 9/9 · base: rfc/s8-audit

Docs policy: pages are standalone snapshots of the current system; all change context lives in one versioned Release Notes page.

What's inside

  • Versioned Release Notes (docs/release_notes/index.md, one section per version, new nav entry) replace CHANGELOG.md (deleted; its current content absorbed). bump-version-and-release skill now targets the Release Notes section per version.
  • write-mkdocs-documentation skill Principle 0: no change-relative language, no RFC/discussion citations in docs pages, motivation-before-mechanics, with a checklist. Per-README changelog sections removed from templates.
  • Deep standalone-snapshot audit of every rendered page (94 docs pages, stack/package/tests READMEs, the generated module catalog and its sources): ~100 RFC citations removed; change-relative narration relocated to Release Notes; factual rot corrected against code (phantom GCS control-panel page, orphaned behavior-tree docs, false bag-recording-at-takeoff claim, DDS allowlist drift, nonexistent CLI commands, dead video embed, and more).
  • Vestigial leftovers removed: trajectory_library's catkin-era rqt selector (never installed by its CMakeLists), orphaned images, empty stub page.

Validation

  • mkdocs build --strict clean (also fixed a pre-existing strict failure); unit suite 397 passed / 7 skipped; module catalog regenerated with zero RFC mentions and registry registered_refs advanced to the audited module HEADs.

🤖 Generated with Claude Code

andrewjong and others added 4 commits August 22, 2026 04:02
…s policy in the writing skill

Owner rulings: docs pages are standalone snapshots of the current
system — no change-relative language, no RFC/discussion citations, no
per-page changelogs; motivation opens every page before mechanics. All
change context coalesces into ONE versioned page,
docs/release_notes/index.md (new Release Notes nav section), which
absorbs CHANGELOG.md's still-current content; CHANGELOG.md is deleted.

- write-mkdocs-documentation skill: new Principle 0 (standalone
  snapshots — prohibited patterns, the release-notes flow,
  motivation-before-mechanics, checklist)
- bump-version-and-release skill: version bumps record changes in the
  Release Notes section for the current version (promotion flow
  retitles the section per release)
- update-documentation skill + package README template: per-README
  Changelog sections removed (the pattern the policy bans)
- docs/README.md excluded from the site build (collides with
  docs/index.md under same-dir); mkdocs build --strict is clean

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…enings, code-truth corrections

Four-domain sweep of every rendered page (94 docs pages, stack READMEs,
nav'd package READMEs, tests/orchestrator READMEs, the generated module
catalog and its sources). ~100 RFC/discussion citations removed —
designs now described on their own terms; change-relative narration
relocated to the versioned Release Notes; pages/sections open with
motivation before mechanics.

Factual rot corrected against code, highlights: phantom GCS control
panel page rewritten for the real Foxglove surface; behavior-tree
framework docs deleted (packages removed in an earlier release — the
behavior layer is drone_safety_monitor); bag recording is NOT
auto-triggered at takeoff; tracking_point/trajectory topic types
corrected; DDS-router allowlist table regenerated from the real config;
nonexistent CLI commands/options (format, test --path/--filter),
robot_bringup, behavior_tree_example, ISAAC_SIM_GUI=false, PX4 Hz
defaults, scene paths, bridge.yaml phantom, Jetson install flow
(./configure.sh -> airstack setup), dead JWT-signed video embed.

Module pipeline: gen_docs_catalog.py strings de-RFC'd + install snippet
fixed (module compose overlay is auto-included); catalog regenerated
(0 RFC mentions); registry fixture snapshot synced; asm_* repos audited
in lockstep and asm_macvo re-pinned to 431d7faf (also fixes its test
stack's dispatcher recursion and stale CI-gap comments).

Gates: unit 397 passed / 7 skipped; mkdocs build --strict clean.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…ector, orphaned images, empty stub page

- trajectory_library shipped a catkin-era (ROS 1) rqt GUI: catkin
  setup.py, plugin.xml, src/rqt_fixed_trajectory_selector/, launcher
  script — none of it referenced by its CMakeLists, so it was never
  installed. Package builds unchanged after removal.
- docs/robot/autonomy/behavior/media/*.png: unreferenced since the
  orphaned behavior-tree pages were deleted.
- docs/development/intermediate/testing/integration_testing.md: empty
  file; its dangling link in the testing index removed.

Gates: unit 397 passed / 7 skipped; mkdocs build --strict clean;
trajectory_library colcon build green.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Test Metrics — aa63097745fe0be3c035dc235b9e26851a2a06cf

No metrics report generated.

Promote the 0.19 series (intent-flag launch workflow, airstack ready,
resolved-config preflight, OSMO ephemeral CI runners, OptiTrack
external-vision configurations, feature-notebook workflow) out of
pre-release: VERSION 0.19.0-alpha.18 -> 0.19.0; CHANGELOG [Unreleased]
promoted to [0.19.0] - 2026-08-22.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
andrewjong and others added 3 commits August 22, 2026 14:24
…he full release history

With CHANGELOG.md deleted in this PR, the Release Notes page is the
single change record; the 0.19.0 section (released to main today)
belongs here so no version's history is lost.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…VERSION stays 0.20.0-alpha.9

The Release Notes page carries the 0.19.0 section, so deleting
CHANGELOG loses nothing.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
A botched release-prep attempt committed develop's pre-audit .env (old
prebuilt comment block, VERSION 0.19.0) onto this branch by accident;
this restores the stack's intended state. CHANGELOG.md, which the same
stray commit resurrected, is already re-deleted in the merge above.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant