Skip to content

Commit 98b9548

Browse files
committed
docs: comprehensive documentation audit fixes
Critical fixes (C2-C6): - Clarify OPENBOOT_GIT_NAME/EMAIL only work in --silent mode - Add NPM packages column to preset summary table - Create complete API reference documentation - Add /api/npm/search endpoint to README - Fix OAuth callback routes (split github/google) Medium priority fixes (M1-M3, M5-M9): - Update doctor example output with outdated packages check - Add update command flags table - Fix --user flag format to <username/slug> - Document install_count tracking feature - Simplify migrations setup in README - Add install_count to DB schema documentation Addresses 13 documentation issues identified in audit
1 parent a292b9f commit 98b9548

File tree

6 files changed

+450
-11
lines changed

6 files changed

+450
-11
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
|-------|-----------|
2323
| Framework | [SvelteKit 5](https://svelte.dev/) + TypeScript |
2424
| Styling | CSS variables (dark/light theme) |
25-
| Auth | GitHub OAuth |
25+
| Auth | GitHub & Google OAuth |
2626
| Database | Cloudflare D1 (SQLite) |
2727
| Hosting | Cloudflare Workers + Pages |
2828

@@ -31,11 +31,8 @@
3131
```bash
3232
npm install
3333

34-
wrangler d1 create openboot-local
35-
wrangler d1 execute openboot-local --local --file=migrations/0001_init.sql
36-
wrangler d1 execute openboot-local --local --file=migrations/0002_add_alias.sql
37-
wrangler d1 execute openboot-local --local --file=migrations/0003_add_dotfiles_repo.sql
38-
wrangler d1 execute openboot-local --local --file=migrations/0004_add_snapshot_and_auth.sql
34+
# Apply all migrations automatically
35+
wrangler d1 migrations apply openboot --local
3936

4037
npm run dev
4138
```
@@ -73,8 +70,9 @@ GitHub repository secrets required: `CLOUDFLARE_API_TOKEN`, `CLOUDFLARE_ACCOUNT_
7370

7471
| Endpoint | Description |
7572
|----------|-------------|
76-
| `GET /api/auth/login` | GitHub OAuth login redirect |
77-
| `GET /api/auth/callback` | GitHub OAuth callback |
73+
| `GET /api/auth/login` | GitHub/Google OAuth login redirect |
74+
| `GET /api/auth/callback/github` | GitHub OAuth callback |
75+
| `GET /api/auth/callback/google` | Google OAuth callback |
7876
| `GET /api/auth/logout` | Clear session |
7977
| `POST /api/auth/cli/start` | Start CLI device auth flow |
8078
| `POST /api/auth/cli/approve` | Approve CLI auth request |
@@ -98,6 +96,7 @@ GitHub repository secrets required: `CLOUDFLARE_API_TOKEN`, `CLOUDFLARE_ACCOUNT_
9896
|----------|-------------|
9997
| `POST /api/brewfile/parse` | Parse Brewfile content into packages |
10098
| `GET /api/homebrew/search?q=` | Search Homebrew packages |
99+
| `GET /api/npm/search?q=` | Search NPM packages |
101100

102101
## Database Schema
103102

@@ -124,6 +123,7 @@ CREATE TABLE configs (
124123
snapshot TEXT,
125124
alias TEXT UNIQUE,
126125
visibility TEXT DEFAULT 'unlisted',
126+
install_count INTEGER DEFAULT 0,
127127
created_at TEXT,
128128
updated_at TEXT
129129
);

0 commit comments

Comments
 (0)