Skip to content

Commit 270cb9a

Browse files
Merge pull request #63 from justinpearson/remove-docs
chore: remove documentation infrastructure
2 parents 1c02a1d + b925ef0 commit 270cb9a

File tree

82 files changed

+8
-15341
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+8
-15341
lines changed

.claude/commands/jp-server-start.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

.claude/commands/jp-server-stop.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

.claude/settings.json

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,15 @@
88
"Bash(yarn test:*)",
99
"Bash(yarn test:coverage:*)",
1010
"Bash(yarn test:e2e:*)",
11-
"Bash(yarn dev-app)",
12-
"Bash(yarn dev-app-stop)",
13-
"Bash(yarn dev-docs)",
11+
"Bash(yarn dev)",
12+
"Bash(yarn dev-stop)",
1413
"Bash(yarn preview-release)",
1514
"Bash(yarn preview-github-pages)",
1615
"Bash(yarn release:*)",
1716
"Bash(yarn screenshot)",
1817
"Bash(yarn list:*)",
1918
"Bash(npx playwright test:*)",
2019
"Bash(npx playwright show-report)",
21-
"Bash(mkdocs serve)",
22-
"Bash(mkdocs build:*)",
2320
"mcp__playwright__browser_click",
2421
"mcp__playwright__browser_console_messages"
2522
]

.cursor/rules/feature_workflow.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

.cursor/rules/git_auto_commit.md

Lines changed: 0 additions & 73 deletions
This file was deleted.

.cursor/rules/mdc_rules_location.md

Lines changed: 0 additions & 55 deletions
This file was deleted.

.github/workflows/build-and-deploy-all.yml

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Jpp Build and Deploy App and Docs
1+
name: Jpp Build and Deploy App
22

33
on:
44
push:
@@ -20,22 +20,12 @@ jobs:
2020
steps:
2121
- uses: actions/checkout@v4
2222

23-
# Node for Vite build
2423
- uses: actions/setup-node@v4
2524
with:
2625
node-version: 20
2726
cache: yarn
2827

29-
# Python for MkDocs build
30-
- uses: actions/setup-python@v5
31-
with:
32-
python-version: "3.12"
33-
cache: "pip"
34-
cache-dependency-path: requirements.txt
35-
3628
- run: yarn install --frozen-lockfile
37-
- run: pip install -r requirements.txt
38-
- run: pip install mkdocs
3929
- run: yarn build
4030

4131
- name: Upload Pages artifact

.github/workflows/docs.yml

Lines changed: 0 additions & 44 deletions
This file was deleted.

CLAUDE.md

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
55
## Quick Reference
66

77
- **Live App**: https://justinpearson.github.io/kidpix/
8-
- **Docs**: https://justinpearson.github.io/kidpix/docs/
98
- **Main Branch**: `main`
109
- **Current Branch**: `name-stamps` (as of October 2025)
1110
- **Tech Stack**: Vanilla JS (~16,300 lines) + Vite 6.4.1 + Vitest + Playwright
@@ -24,7 +23,6 @@ This is a modular JavaScript implementation of the classic 1989 Kid Pix drawing
2423
- Enhanced color picker tool
2524
- Improved image organization (moved to logical folders)
2625
- GitHub releases support for offline distribution
27-
- Comprehensive documentation for users and maintainers
2826
- Browser error monitoring integration for AI-assisted development
2927
- Removed ESLint/Prettier to reduce development friction (AI writes correct code without them)
3028

@@ -57,7 +55,6 @@ Following the pattern from `.cursor/rules/git_auto_commit.md`, when implementing
5755
- Complete one feature component → **COMMIT IMMEDIATELY**
5856
- Complete configuration setup → **COMMIT IMMEDIATELY**
5957
- Complete testing setup → **COMMIT IMMEDIATELY**
60-
- Complete documentation → **COMMIT IMMEDIATELY**
6158

6259
### Benefits:
6360

@@ -90,8 +87,7 @@ The project uses GitHub Actions for continuous integration and deployment:
9087

9188
1. **build-and-deploy-all.yml** (PRIMARY - Active)
9289
- Triggers: Push to main, manual workflow_dispatch
93-
- Builds app with Vite (to `dist/`)
94-
- Builds docs with MkDocs (to `dist/docs/`)
90+
- Builds app with Vite (to `dist/` and `dist-gh/`)
9591
- Deploys to GitHub Pages at https://justinpearson.github.io/kidpix/
9692
- Sets base URL to `/kidpix/` for GitHub Pages
9793

@@ -111,9 +107,6 @@ The project uses GitHub Actions for continuous integration and deployment:
111107
- Alternative deployment workflow
112108
- Runs tests before deploying
113109

114-
5. **docs.yml** (Superseded by build-and-deploy-all.yml)
115-
- Previously built docs separately
116-
117110
### Release Process
118111

119112
To create a new release:
@@ -138,7 +131,6 @@ The release workflow automatically:
138131
### Deployment URLs
139132

140133
- **Live App**: https://justinpearson.github.io/kidpix/
141-
- **Documentation**: https://justinpearson.github.io/kidpix/docs/
142134
- **Releases**: https://github.com/justinpearson/kidpix/releases
143135

144136
## Development Commands
@@ -158,13 +150,12 @@ yarn dev-app-stop # Stop the background dev server
158150
### Build
159151

160152
```bash
161-
yarn build # Build app and docs for both local (dist/) and GitHub Pages (dist-gh/)
153+
yarn build # Build app for both local (dist/) and GitHub Pages (dist-gh/)
162154
```
163155

164156
**Build Notes:**
165157
- Creates `dist/` directory for local deployment (base URL: `/`)
166158
- Creates `dist-gh/` directory for GitHub Pages deployment (base URL: `/kidpix/`)
167-
- Both builds include app + docs (MkDocs output in `docs/` subdirectory)
168159

169160
### Testing
170161

@@ -176,16 +167,6 @@ yarn test:e2e # Run Playwright end-to-end tests (headless)
176167
yarn test:e2e:headed # Run Playwright tests with visible browser
177168
```
178169

179-
### Documentation
180-
181-
```bash
182-
yarn dev-docs # Start MkDocs dev server at http://127.0.0.1:8000/
183-
```
184-
185-
**Documentation Notes:**
186-
- Docs are built as part of `yarn build` (no separate docs:build command)
187-
- MkDocs outputs to `dist/docs/` and `dist-gh/docs/`
188-
189170
### Preview Built App
190171

191172
```bash
@@ -398,7 +379,6 @@ KiddoPaint.Tools.Toolbox.ToolName = function () {
398379
- `src/kidpix-main.js`: Main entry point for React version (future)
399380
- `src/test-setup.ts`: Vitest test setup
400381
- `index.html`: Main application entry point loading modular JS files
401-
- `doc/`: Documentation built with MkDocs (user and maintainer guides)
402382
- `prompts-TODO/`: Feature request files (newest first)
403383
- `prompts-DONE/`: Completed feature requests
404384
- `util/`: Utility scripts for stamp management

0 commit comments

Comments
 (0)