Skip to content

Commit 4f2aff4

Browse files
committed
doc updates
1 parent c32e60f commit 4f2aff4

3 files changed

Lines changed: 10 additions & 5 deletions

File tree

AGENTS.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,12 @@ Context for AI assistants working on this repo.
3636
- **src/index.ts**: Re-exports schemas, utils, CLI, and components.
3737
- **README**: “Use as a library” section with `npm install github:devalbo/tb-solid-pod` and example imports.
3838

39+
4. **GitHub Pages (code)**
40+
Vite `base` is env-driven (`BASE_PATH` in CI). `.github/workflows/pages.yml` runs on every push to `main`, builds with `BASE_PATH=/tb-solid-pod/`, and deploys `dist/` to the `gh-pages` branch. README has Live demo link and a "Live demo 404?" note (private repo = no Pages on free plan).
41+
3942
## What’s not done
4043

41-
- **GitHub Pages (manual)**: In repo **Settings → Pages**, set "Deploy from a branch", branch `gh-pages`, folder root. (Code is done: Vite `base` env-driven, `.github/workflows/pages.yml` deploys `dist/` to `gh-pages`; README has Live demo link.)
44+
- **GitHub Pages (manual)**: In repo **Settings → Pages**, set "Deploy from a branch", branch `gh-pages`, folder root. (Code is done: Vite `base` env-driven, `.github/workflows/pages.yml` deploys `dist/` to `gh-pages`; README has Live demo link.) The live site returns **404 if the repo is private** on a free account—make the repo public or use GitHub Pro.
4245
- **Optional**: Repo description/topics on GitHub; README “Library usage” expansion; npm publish later.
4346

4447
## Plan and checklists
@@ -56,7 +59,7 @@ Context for AI assistants working on this repo.
5659

5760
## Useful docs
5861

59-
- **README.md** – Overview, limitations, Integration Guide (copy-paste vs install-from-GitHub), CLI command list.
62+
- **README.md** – Overview, limitations, Use as a library, Integration Guide (copy-paste vs install-from-GitHub), Getting Started (Node note, Live demo + 404 troubleshooting), CLI command list.
6063
- **docs/GITHUB_AND_LIBRARY_PLAN.md** – Goals, current state, section checklists, File Summary, Success Criteria.
6164
- **docs/IMPLEMENTATION_PLAN.md** – Feature/phases.
6265
- **DESIGN.md** – Design notes.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -396,6 +396,8 @@ export function createProject(input: { name: string }, baseUrl: string) {
396396

397397
**[Try the live demo](https://devalbo.github.io/tb-solid-pod/)** or run locally. Requires Node 18+ (or use `nvm use` if you use nvm).
398398

399+
**Live demo 404?** GitHub Pages does not work with private repos on a free account. Make the repo public (Settings → General → Danger zone → Change visibility) or use GitHub Pro. Then set **Settings → Pages** → Deploy from branch **gh-pages**, folder **/ (root)**. The workflow deploys on every push to `main`.
400+
399401
```bash
400402
npm install
401403
npm run dev

docs/GITHUB_AND_LIBRARY_PLAN.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ Summary of what exists in the repo today.
3232
| **App entry** | Done | `index.html` + `src/main.tsx`; scripts `dev`, `build`, `preview`, `lint` present. |
3333
| **Source layout** | Done | `src/schemas/`, `src/utils/`, `src/cli/`, `src/components/` with expected files. |
3434
| **LICENSE** | Done | AGPL-3.0-or-later in repo; `package.json` has `"license": "AGPL-3.0-or-later"`. |
35-
| **README** | Partial | Has “Getting Started (Demo App)” with `npm install` / `npm run dev`. No Node version note, no “Use as a libraryinstall-from-GitHub section, no “Live demo link. Integration Guide documents copy-paste and schema-only use. |
36-
| **Runnable on checkout** | Partial | Commands work; no `.nvmrc`; README matches commands. |
35+
| **README** | Done | Has “Getting Started (Demo App)” with `npm install` / `npm run dev`. Node 18+ / `nvm use`; "Use as a library" with install-from-GitHub; Live demo link; 404 note. Integration Guide for copy-paste and schema-only use. |
36+
| **Runnable on checkout** | Done | Commands work; `.nvmrc` (20); README matches. |
3737
| **Library packaging** | Done | `package.json`: version 0.1.0, description, keywords, main, types, exports, files; `src/index.ts` re-exports schemas, utils, CLI, components; README “Use as a library” section. |
38-
| **GitHub Pages** | Done (code) | `vite.config.js` base env-driven; `.github/workflows/pages.yml` builds with `BASE_PATH=/tb-solid-pod/` and deploys to `gh-pages`; README has Live demo link. **You must set Settings → Pages: Deploy from branch `gh-pages`.** |
38+
| **GitHub Pages** | Done (code) | `vite.config.js` base env-driven; `.github/workflows/pages.yml` deploys to `gh-pages` on every push to `main`; README has Live demo link + 404 note. **Manual:** Settings → Pages: Deploy from branch `gh-pages`. **Private repo = 404 on free plan;** make repo public or use GitHub Pro for the live site. |
3939
| **GitHub repo** | Done | Repo on GitHub (`devalbo/tb-solid-pod`), main pushed, LICENSE in repo. **Repo is private for now**; make public when you want install-from-GitHub or a public Live demo. |
4040

4141
**Next steps (in order):**

0 commit comments

Comments
 (0)