Repository navigation
docs: mark the alpha's development APIs and verify the first-test guide - #28
Merged
Merged
Conversation
The review note and PUBLISHING.md recorded the repository's private status, docs 404s and hosted-CI billing on 2026-10-24. That goes stale and would become public with the repo. Also: the user opens the log in AdvantageScope (it does not open on its own), and the root holds the desktop module and examples beside the library.
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.
Replaces #26, which GitHub closed when its base branch (
feat/vision-fidelity, merged as #24) was deleted and could not reopen after the rebase. Same branch, now rebased ontomain; hosted CI runs here now that the repository is public. The notes below are from #26.Release UI scope: SimLoop runs from the robot project or harness and displays through a separate AdvantageScope window. The standalone app around SimLoop is not ready and is not included. This documentation PR adds a plot of logged values, not an app UI screenshot.
The pending vision API is newer than the pinned alpha starter, and the documentation currently blurs that boundary. This updates the guide against
feat/vision-fidelityat4b40ef9, fills in vision setup and lifecycle details, and makes the first test reproducible.api-reference/so copying generated Javadoc cannot overwrite it.docs/documentation-review-2026-10-24.md.Validation:
:SimLoop:docsSite --offlinepasses with strict MkDocs, API doclint, version and tutorial consistency checks. The documented slide test passes (150 logged frames; final 11.999820053 in, peak 13.150056536 in). A deliberately changed snippet is rejected. Rendered crawl checks 29 guides, generated-reference targets, 2,244 local links and 60 image references with no missing targets, anchors or alt text. The leak gate passes all 10 rules over 403 files. Full localtest :SimLoop:docsSite --offlinepasses all 1,257 tests (1,249 library, six desktop, two starter), with no failures, errors or skips. New pages and the plot were inspected visually.JitPack’s alpha build status is ok and its served POM returns HTTP 200 with the expected compile-scope dependencies. Hosted CI could not start: test/docs run and leak/secret run report an account payment/spending-limit restriction before any job steps. Local checks are not a hosted CI pass.
This remains a draft for review. It is stacked on #24; streaming, cleanup, analytics and branding documentation remain with #21–#25. No release, deployment or visibility change is made. The OpenCV fragment requires a consuming processor/native library; this PR does not claim end-to-end OpenCV execution.
Responsive verification before the scope clarification: all 55 guide pages across both sites passed at 320, 390 and 768 px with no page-width overflow.