Skip to content

Add the Switchify PC docs site (pc.theswitchify.app) - #1076

Merged
enaboapps merged 3 commits into
mainfrom
feat/1075-docs-site
Oct 15, 2026
Merged

enaboapps merged 3 commits into
mainfrom
feat/1075-docs-site

Conversation

@enaboapps

Copy link
Copy Markdown
Contributor

Closes #1075

Adds site/, an Astro Starlight documentation site to be served at https://pc.theswitchify.app, and a line in AGENTS.md so that any user-visible change updates it in the same pull request. That is the point: the docs live next to the code and the agents that change the app keep them current, instead of the marketing site drifting from the product.

Pages (15): overview; install; add a switch; Home menu; point scanning; mouse panel and radar; keyboard; word prediction; scanning settings; pair your device; PC control; Switch Forwarding; account, updates and privacy; troubleshooting; plus a link to GitHub releases. Written for switch users and AT professionals from docs/, src/help/demonstrations.ts, the settings UI and scan_menu.rs. No accuracy claims for prediction; the vocabulary is described as English; learned words are described as stored locally.

Self-contained: its own package.json under site/, so root lint/test/build are unaffected (npm run lint at the root still passes). The site builds with cd site && npm ci && npm run build.

Hosting (needs Owen): create a Vercel project for this repo with root directory site (framework: Astro), and point pc.theswitchify.app at it.

Validation

  • cd site && npm install && npm run build: 15 pages, search index built, no warnings
  • Root npm run lint: passes
  • Previewed light, dark and 390 px wide

🤖 Generated with Claude Code

- New `site/` folder: an Astro Starlight site, self-contained with its own
  package.json so the root checks are unaffected
- Fifteen pages written from docs/, the in-app help and the settings UI:
  install, add a switch, Home menu, point scanning, mouse panel and radar,
  keyboard, word prediction, scanning settings, pairing, PC control,
  Switch Forwarding, account/updates/privacy, troubleshooting
- Switchify red theme tokens shared with www.theswitchify.app, visible
  focus ring, light and dark
- AGENTS.md: any user-visible change must update site/ in the same PR

Closes #1075

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@enaboapps enaboapps added this to the v1.0.0-rc.28 milestone Oct 15, 2026
- Word prediction has eight slots: three instant words, two AI words,
  three two-word phrases
- Closing the keyboard returns to where it was opened from
- Select opens Home by default; Point is chosen from there
- Drags stay on one display; More also offers Alt-click and Windows-click
- Automatic spacing and capitals are not a toggle
- PC control: drop the four-key shortcut limit, pointer speed is slow to
  fast, remote scanning needs Switchify scanning chosen on the phone
- Drop the release-candidate status line so the overview does not go stale
- AGENTS.md: no accuracy claims for word prediction; point at site/README.md

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…identity check

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@enaboapps
enaboapps merged commit 4a2efda into main Oct 15, 2026
6 checks passed
@enaboapps
enaboapps deleted the feat/1075-docs-site branch October 15, 2026 16:07
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.

Add the Switchify PC docs site (pc.theswitchify.app)

2 participants