Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ The frozen C# application is not maintained in this repository. Do not reintrodu
- When a version is released, close its milestone if it has no open issues. If open issues remain, move unfinished work to the next open milestone (or ask) before closing the shipped one.
- Close tracking or epic issues when every scoped child issue/PR they list is merged or closed. Do not leave completed tracking issues open with unchecked boxes.
- Keep commits and pull requests focused on that issue.
- Any change users can see (a feature, a setting, a menu item, a label, a behaviour) must update the docs site in `site/` in the same pull request. It is served at https://pc.theswitchify.app. Write for switch users and AT professionals in plain language, claim only what the app does, make no accuracy claims for word prediction, and check it builds (see `site/README.md`).
- Open a draft pull request with the issue-closing reference and validation evidence. Assign the same milestone as the issue.
- Before handoff, deploy an independent agent that did not implement the change to review the pull request's latest head, and address all actionable findings. If review fixes change the head, repeat the independent review on the new latest head.
- Make the pull request ready for review and ensure required CI passes.
Expand Down
3 changes: 3 additions & 0 deletions site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules/
dist/
.astro/
16 changes: 16 additions & 0 deletions site/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Switchify PC docs site

The user documentation for Switchify PC, served at https://pc.theswitchify.app. It is an [Astro Starlight](https://starlight.astro.build) site and is independent of the app build.

```bash
cd site
npm ci
npm run dev # http://localhost:4321
npm run build # static output in dist/
```

Pages live in `src/content/docs/` as Markdown. The sidebar is defined in `astro.config.mjs`.

Any change that users can see in the app must update these pages in the same pull request. Write for switch users and AT professionals: plain language, no claims the app does not back up, and no accuracy claims for word prediction.

Hosting: a Vercel project for the `switchify-pc` repository with its root directory set to `site`, and `pc.theswitchify.app` pointed at it.
52 changes: 52 additions & 0 deletions site/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';

export default defineConfig({
site: 'https://pc.theswitchify.app',
integrations: [
starlight({
title: 'Switchify PC',
description: 'Switch access for Windows and Mac. How to set up Switchify PC, scan, type, and pair it with Switchify on Android.',
social: [
{ icon: 'github', label: 'GitHub', href: 'https://github.com/switchifyapp/switchify-pc' },
],
editLink: {
baseUrl: 'https://github.com/switchifyapp/switchify-pc/edit/main/site/',
},
lastUpdated: true,
customCss: ['./src/styles/custom.css'],
sidebar: [
{ label: 'Overview', slug: 'index' },
{
label: 'Get started',
items: [
{ label: 'Install', slug: 'get-started/install' },
{ label: 'Add a switch', slug: 'get-started/add-a-switch' },
],
},
{
label: 'Using the computer',
items: [
{ label: 'Home menu', slug: 'using/home-menu' },
{ label: 'Point scanning', slug: 'using/point-scanning' },
{ label: 'Mouse panel and radar', slug: 'using/mouse-panel' },
{ label: 'Keyboard', slug: 'using/keyboard' },
{ label: 'Word prediction', slug: 'using/word-prediction' },
{ label: 'Scanning settings', slug: 'using/scanning-settings' },
],
},
{
label: 'With Switchify on Android',
items: [
{ label: 'Pair your device', slug: 'android/pairing' },
{ label: 'PC control', slug: 'android/pc-control' },
{ label: 'Switch Forwarding', slug: 'android/switch-forwarding' },
],
},
{ label: 'Account, updates and privacy', slug: 'account-and-privacy' },
{ label: 'Troubleshooting', slug: 'troubleshooting' },
{ label: 'Release notes', link: 'https://github.com/switchifyapp/switchify-pc/releases' },
],
}),
],
});
Loading
Loading