Skip to content

docs: reconcile public docs to v0.1.0-beta.3 + current status#453

Merged
ibanner56 merged 2 commits into
mainfrom
isaacbanner-docs-reconcile
Jul 22, 2026
Merged

docs: reconcile public docs to v0.1.0-beta.3 + current status#453
ibanner56 merged 2 commits into
mainfrom
isaacbanner-docs-reconcile

Conversation

@ibanner56

Copy link
Copy Markdown
Owner

What & why

Public-facing docs had drifted out of sync with reality (stale version, self-contradictory install/signing status, "coming soon" hedges for things that already shipped). This reconciles every user-/community-facing doc against a single, code-/CI-verified source of truth.

Ground truth (verified)

  • Version / current release: v0.1.0-beta.3 (app/pubspec.yaml 0.1.0+1; latest release + beta.json).
  • Per-platform signing (verified from the beta.3 release run logs, .github/workflows/release.yml):
    • macOS — signed with Developer ID + notarized & stapled ("The staple and validate action worked!").
    • Androidsigned release APK ("Android signing secrets configured; building + staging a signed APK").
    • Windows / Linuxunsigned (deliberate; deferred signing wave).
    • iOS / iPadOSTestFlight only (invite; no sideload/unsigned path per ADR-002).

Changes (docs only)

  • docs/beta/beta-guide.md — replaced the self-contradictory "installation not packaged / run a dev build" and "dialect library + .USR still in progress" bullets (all shipped) with an accurate per-platform signing note; pointed How to join and How to give feedback at the now-live Join the beta and issue forms.
  • site/index.html — version pill v0.1.0-beta.2 to v0.1.0-beta.3 (static fallback; app.js already self-aligns from beta.json).
  • docs/product/beta-recruitment.md — dropped stale "installers still being packaged / run a development build" claims from the templates and the honesty note.
  • docs/ROADMAP.md §7 — reconciled both directions: GitHub Pages now enabled (manifests hosted + landing page feat(site): add public landing page (GitHub Pages) #408), Discussions enabled, beta-signup form (docs(beta): add dedicated beta signup form, split from check-in #413) delivered, beta execution in progress, current release beta.3.
  • README.md — all issue forms are live now (not "joining as the beta rolls out"); added Join-the-beta form + project landing-page links.

No app code or configuration changes. docs/user/* bundle is untouched, so the in-app doc bundle is unaffected.

Establish a single source of truth for the app version and per-platform
install/signing status (verified against app/pubspec.yaml, CHANGELOG, and
the beta.3 release.yml run), then make every public-facing doc consistent:

- Version: current release is v0.1.0-beta.3 (was beta.2 in the site pill).
- Signing (verified from the beta.3 release run logs): macOS signed +
  Developer ID + notarized/stapled; Android signed APK; Windows/Linux
  unsigned; iOS TestFlight-only (invite).

Fixes:
- beta-guide: replace the self-contradictory "installation not packaged /
  run a dev build" + "dialect library & .USR still in progress" bullets
  (all shipped) with an accurate per-platform signing note; point "How to
  join" and feedback sections at the now-live Join-the-beta and issue forms.
- site/index.html: version pill v0.1.0-beta.2 -> v0.1.0-beta.3 (fallback;
  app.js already self-aligns from beta.json).
- beta-recruitment: drop stale "installers still being packaged / dev build"
  claims from the templates and honesty note; builds ship for every platform.
- ROADMAP §7: GitHub Pages now enabled (manifests hosted + landing page #408);
  Discussions enabled; beta signup form #413 delivered; beta execution
  in progress; current release is beta.3 (was beta.1/beta.2).
- README: beta/feedback section — all issue forms are live now; add the
  Join-the-beta form and project landing-page links.

Docs only; no app code or configuration changes.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Reconciles public documentation with beta.3 release status, platform distribution, and live community channels.

Changes:

  • Updates release and signing status.
  • Refreshes beta recruitment and feedback guidance.
  • Points users to live downloads and signup forms.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
site/index.html Updates fallback version to beta.3.
README.md Adds beta signup and project-site links.
docs/ROADMAP.md Updates release, Pages, and beta status.
docs/product/beta-recruitment.md Removes obsolete development-build messaging.
docs/beta/beta-guide.md Updates installation, signup, and feedback guidance.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/beta/beta-guide.md Outdated
Comment thread docs/beta/beta-guide.md Outdated
Comment thread docs/ROADMAP.md Outdated
Comment thread README.md
Comment thread site/index.html
- beta-guide: keep Apple ID / TestFlight emails out of the public signup
  issue — sign up via the form for platforms, send the invite address
  privately to isaac@banner.is instead.
- beta-guide: correct per-platform first-run steps — Android still needs a
  one-time "install unknown apps" sideload permission, Windows shows
  SmartScreen, Linux has no signing prompt (just the executable bit); matches
  docs/user/installation.md.
- ROADMAP §7.3: "builds ship for every platform" now retains the signing
  qualifiers so it no longer contradicts the §7.1 status (Win/Linux unsigned).
- CONTRIBUTING.md: the beta-specific forms are all live now (not "as the beta
  rolls out") and add the Join-the-beta signup.
- releasing.md: version-fallback bullet no longer embeds a specific beta
  version.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@ibanner56
ibanner56 merged commit a47fd0a into main Jul 22, 2026
7 checks passed
@ibanner56
ibanner56 deleted the isaacbanner-docs-reconcile branch July 22, 2026 05:05
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