Skip to content

docs: refresh the live-site sources for the AdvantageScope workflow - #27

Closed
Slooquie wants to merge 1 commit into
mainfrom
docs/live-site-refresh-2026-10-24
Closed

Slooquie wants to merge 1 commit into
mainfrom
docs/live-site-refresh-2026-10-24

Conversation

@Slooquie

Copy link
Copy Markdown

The published documentation sources lack installation and recovery details, and the generated Javadoc overwrites the guide’s API landing route. This ports the main-compatible documentation improvements from #26 onto main at 7e06448.

  • State the release scope: SimLoop runs from the robot project or harness and displays in a separate AdvantageScope window. The surrounding standalone app is not ready or included.
  • Keep the geometry-only vision API on main. No pending distortion, occlusion, tilted-tag or synthetic-frame API from feat(vision): distortion, occlusion and synthetic frames #24 is advertised.
  • Clarify installation, SDK prerequisites, model time, logging ownership, hardware behavior and agent setup.
  • Add the slide-test plot, recorded values and regeneration tools; check the complete Java tutorial against its compiled example during docs builds.
  • Move the API landing page to api-reference/ and correct full-site preview instructions; fix narrow-screen article gutters.

Validation: :SimLoop:docsSite --offline passes, including API doclint, version and example checks. The slide test passes on main (one test, no failures/errors/skips); its source is identical to the version used to record the plot. The leak gate passes all 10 rules over 393 files. The rendered crawl passes 2,196 local links and 59 image references across 29 guide pages; narrow-width checks pass. API landing and guide pages were inspected in Chrome.

This updates the repository that publishes /simloop/. It does not deploy, tag, change visibility or restore Pages settings. The public route and Pages API returned 404 during this review. Previous CI attempts were blocked before jobs started by an account payment/spending-limit restriction; no hosted CI pass is claimed. The main-specific review record is docs/live-site-review-2026-10-24.md.

@featurescript

Copy link
Copy Markdown
Contributor

Closing as a duplicate of #26, which has the same docs rebuilt on top of #24's vision work. This branch's vision page would be wrong once #24 lands, and the two PRs conflict in 7 files.

@featurescript
featurescript deleted the docs/live-site-refresh-2026-10-24 branch October 26, 2026 23:32
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.

2 participants