Skip to content

Align current documentation and recruit field testers - #8

Merged
berginj merged 2 commits into
mainfrom
codex/docs-testing-status
Jul 21, 2026
Merged

Align current documentation and recruit field testers#8
berginj merged 2 commits into
mainfrom
codex/docs-testing-status

Conversation

@berginj

@berginj berginj commented Jul 21, 2026

Copy link
Copy Markdown
Owner

What changed

  • replaces stale public status and test claims with the current evidence boundary
  • establishes docs/ROADMAP.md as the only canonical open-work list
  • adds a privacy-safe docs/TESTING_NEEDED.md call for installer, camera, setup-recovery, and physical-reference testing
  • updates v2 setup steps, release gaps, version guidance, requirements, changelog, and contribution guidance
  • updates GitHub issue forms to request commit/snapshot identity and explicit denominators
  • marks dated strategy, pilot, prototype, and legacy validation pages as context rather than current status

Why

The repository had competing v1.5/v2.0 status pages, obsolete 389/841/1051 test counts, six/nine-step setup descriptions, and completed software items still listed as pending. Public documentation also needed to distinguish automated software evidence from physical accuracy validation.

Validation

  • active local Markdown links checked successfully
  • GitHub issue templates parsed as YAML
  • git diff --check passed
  • current required CI run: 1,263 passed / 32 skipped / 0 failed on Python 3.11; Python 3.12 and security also passed on the CI-restoration change

Tester impact

The README and testing guide now direct volunteers to structured validation and pilot-feedback forms without requesting private athlete media or unsupported accuracy claims.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 62bec7a6b9

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/README.md
## User and operator guides

- [QUICK_START.md](QUICK_START.md)
- [user/FAQ.md](user/FAQ.md)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Point the docs index at the refreshed FAQ

This current documentation index still sends users to docs/user/FAQ.md, but this commit's v2 install/status edits were made in docs/FAQ.md instead. The linked FAQ remains at Version 1.2.0 and still tells users to download the pilot installer from GitHub Releases, so readers following the new canonical docs get obsolete installation/release guidance and miss the new no-installer caveat. Please either update docs/user/FAQ.md or link this index to the refreshed FAQ.

Useful? React with 👍 / 👎.

Comment thread docs/HARDWARE_PROFILE.md
**Date:** March 26, 2026
**Version:** 1.0 (for v1.5.0-pilot)
**Date:** March 26, 2026; status reviewed July 21, 2026
**Version:** Candidate profile for v2.0.0 testing

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Don't mark stale webcam guidance as v2 testing

By marking this hardware profile as the v2.0.0 testing profile, the existing purchase guidance in the same file becomes current again even though it still recommends Logitech C920/BRIO/LifeCam-style webcams, while the new roadmap and testing docs ask for global-shutter qualification and the code catalog only recognizes ArduCam global-shutter devices. Testers following this current guide can buy or report unrecognized/non-global-shutter hardware, producing validation data that does not satisfy the new evidence boundary. Please replace the old webcam recommendations or keep this document historical until it is updated.

Useful? React with 👍 / 👎.

@berginj
berginj force-pushed the codex/docs-testing-status branch from 62bec7a to 83f9ae6 Compare July 21, 2026 20:22
@berginj
berginj merged commit 4040014 into main Jul 21, 2026
3 checks passed
@berginj
berginj deleted the codex/docs-testing-status branch July 21, 2026 20:30
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