|
| 1 | +# Installer Distribution and Documentation Implementation Plan |
| 2 | + |
| 3 | +> **For Claude:** REQUIRED SUB-SKILL: Use superpowers:executing-plans to implement this plan task-by-task. |
| 4 | +
|
| 5 | +**Goal:** Resolve GitHub issues #19 and #20 by replacing GitHub raw installer guidance with an OSS/CDN-ready distribution convention and adding a coherent documentation experience to the existing site. |
| 6 | + |
| 7 | +**Architecture:** Keep the Rust CLI at the repository root and the web experience in `site/`. Treat installer distribution as release documentation plus a reusable URL contract, and treat docs as a first-class route group in the existing TanStack Start app so landing and docs share copy, navigation, and styles. |
| 8 | + |
| 9 | +**Tech Stack:** Rust CLI, POSIX shell installer, TanStack Start, React, TypeScript, Vite, CSS, Fumadocs-compatible documentation structure. |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +### Task 1: Document the Installer Distribution Contract |
| 14 | + |
| 15 | +**Files:** |
| 16 | +- Modify: `README.md` |
| 17 | +- Modify: `docs/release.md` |
| 18 | +- Modify: `CHANGELOG.md` |
| 19 | + |
| 20 | +**Steps:** |
| 21 | + |
| 22 | +1. Add an OSS/CDN installer URL convention with one stable script path: |
| 23 | + - `https://<oss-or-cdn-domain>/ocvm/install.sh` |
| 24 | +2. Document repeatable automation as `curl .../install.sh | OCVM_VERSION=v0.1.1 sh`. |
| 25 | +3. Keep GitHub raw as a maintainer fallback, not the primary user-facing install path. |
| 26 | +4. Document `OCVM_INSTALLER_BASE_URL` as the release-time prefix maintainers publish to object storage. |
| 27 | +4. Update changelog with user-facing installer guidance changes. |
| 28 | +5. Verify with `rg -n "raw.githubusercontent.com|OCVM_INSTALLER_BASE_URL|oss-or-cdn" README.md docs site install.sh CHANGELOG.md`. |
| 29 | + |
| 30 | +### Task 2: Add Shared Site Content for Install and Docs Navigation |
| 31 | + |
| 32 | +**Files:** |
| 33 | +- Create: `site/src/content.ts` |
| 34 | +- Modify: `site/src/routes/index.tsx` |
| 35 | + |
| 36 | +**Steps:** |
| 37 | + |
| 38 | +1. Extract current release, installer base URL, install command, repo URL, release URL, docs URL, and star label into `site/src/content.ts`. |
| 39 | +2. Use the shared install command on the landing page. |
| 40 | +3. Add a GitHub star link in the top navigation with a static accessible label. |
| 41 | +4. Point Docs navigation to `/docs` instead of a GitHub blob URL. |
| 42 | +5. Verify TypeScript imports by running `npm run build --prefix site`. |
| 43 | + |
| 44 | +### Task 3: Add Documentation Routes |
| 45 | + |
| 46 | +**Files:** |
| 47 | +- Create: `site/src/routes/docs.tsx` |
| 48 | +- Create: `site/src/routes/docs.installation.tsx` |
| 49 | +- Create: `site/src/routes/docs.commands.tsx` |
| 50 | +- Create: `site/src/routes/docs.configuration.tsx` |
| 51 | +- Create: `site/src/routes/docs.release-sources.tsx` |
| 52 | + |
| 53 | +**Steps:** |
| 54 | + |
| 55 | +1. Build `/docs` as an overview page with links to the four documentation pages. |
| 56 | +2. Add install docs covering the OSS/CDN convention and local bin setup. |
| 57 | +3. Add command docs matching the README command surface. |
| 58 | +4. Add configuration docs for `OCVM_HOME`, `OCVM_NPM_PACKAGE`, `OCVM_SOURCE`, and release manifest URL. |
| 59 | +5. Add release-source docs for npm and manifest source behavior. |
| 60 | +6. Keep docs content concise and current. |
| 61 | +7. Verify route generation/build with `npm run build --prefix site`. |
| 62 | + |
| 63 | +### Task 4: Unify Landing and Docs Styling |
| 64 | + |
| 65 | +**Files:** |
| 66 | +- Modify: `site/src/styles.css` |
| 67 | + |
| 68 | +**Steps:** |
| 69 | + |
| 70 | +1. Add shared top navigation styles that work for both landing and docs pages. |
| 71 | +2. Add docs layout styles with readable width, sidebar-like page index, and code blocks. |
| 72 | +3. Keep card radius at 8px or less and avoid nested cards. |
| 73 | +4. Check responsive rules for mobile and desktop. |
| 74 | +5. Verify visually with a local site server and browser screenshots when feasible. |
| 75 | + |
| 76 | +### Task 5: Verify Repository Gates |
| 77 | + |
| 78 | +**Commands:** |
| 79 | + |
| 80 | +```bash |
| 81 | +cargo fmt --check |
| 82 | +cargo clippy --all-targets -- -D warnings |
| 83 | +cargo test |
| 84 | +npm run build --prefix site |
| 85 | +cargo build --release |
| 86 | +cargo package --allow-dirty |
| 87 | +rg --hidden --no-ignore -n "private-token|secret|internal-domain.example|HOME_PATH_PLACEHOLDER" . --glob '!target/**' --glob '!.git/**' --glob '!.omx/**' --glob '!AGENTS.md' --glob '!CONTRIBUTING.md' --glob '!SECURITY.md' |
| 88 | +``` |
| 89 | + |
| 90 | +If network or package-cache constraints block the site build, record the exact command and failure output, then run all checks that do not require new network access. |
| 91 | + |
| 92 | +### Task 6: Publish the Branch |
| 93 | + |
| 94 | +**Steps:** |
| 95 | + |
| 96 | +1. Inspect `git status --short --branch`. |
| 97 | +2. Review changed files for generated output, secrets, and machine paths. |
| 98 | +3. Commit with a concise conventional commit message ending with: |
| 99 | + |
| 100 | +```text |
| 101 | +Generated with Codex |
| 102 | +
|
| 103 | +Co-Authored-By: Codex <noreply@openai.com> |
| 104 | +``` |
| 105 | + |
| 106 | +4. Push the branch. |
| 107 | +5. Create or reuse a GitHub Pull Request. |
| 108 | +6. Include validation commands and remaining risks in the PR summary. |
0 commit comments