hartle-tech/medusa
1
0
Fork 0
Code Issues 12 Pull requests Projects Releases Packages Wiki Activity Actions

docs(S01E37): set up docs/external/ VitePress site (mirror dumpsock pattern) #11

New issue
Open
opened 2026-05-16 03:21:18 +00:00 by hartle-tech · 0 comments
hartle-tech commented 2026-05-16 03:21:18 +00:00 (Migrated from github.com)
Copy link

Scaffold the public docs site at docs/external/. Mirror dumpsock's pattern (single VitePress build at root, brand-themed, Apache-2.0 site).

Acceptance:

  • docs/external/ VitePress project (matches dumpsock/docs/external/ structure)
  • docs/external/.vitepress/config.ts — title, hero, nav (Guide / Hardware / Security / Source / GitHub)
  • docs/external/.vitepress/theme/ — brand tokens from assets/brand/brand_tokens.yaml
  • appearance: false (light-only per brand)
  • Hero references mascot SVG (block on M3 winner)
  • docs/external/donate.md matching dumpsock pattern
  • docs/package.json with build + dev + preview scripts
  • .github/workflows/docs-build.yml build-check (no Pages deploy — VPS Ansible role serves it)

References: MISSION.md (M5), dumpsock pattern at ~/Projects/dumpsock/docs/

Scaffold the public docs site at `docs/external/`. Mirror dumpsock's pattern (single VitePress build at root, brand-themed, Apache-2.0 site). **Acceptance**: - [ ] `docs/external/` VitePress project (matches dumpsock/docs/external/ structure) - [ ] `docs/external/.vitepress/config.ts` — title, hero, nav (Guide / Hardware / Security / Source / GitHub) - [ ] `docs/external/.vitepress/theme/` — brand tokens from `assets/brand/brand_tokens.yaml` - [ ] `appearance: false` (light-only per brand) - [ ] Hero references mascot SVG (block on M3 winner) - [ ] `docs/external/donate.md` matching dumpsock pattern - [ ] `docs/package.json` with `build` + `dev` + `preview` scripts - [ ] `.github/workflows/docs-build.yml` build-check (no Pages deploy — VPS Ansible role serves it) References: `MISSION.md` (M5), dumpsock pattern at `~/Projects/dumpsock/docs/`
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
develop
No results found.
Labels
Clear labels   
bug
Something isn't working

  
documentation
Improvements or additions to documentation

  
duplicate
This issue or pull request already exists

  
enhancement
New feature or request

  
good first issue
Good for newcomers

  
help wanted
Extra attention is needed

  
invalid
This doesn't seem right

  
question
Further information is requested

  
wontfix
This will not be worked on

  
⚙ firmware
ESP32-S3 firmware work

  
✨ feature
New functionality

  
🎨 brand
Mascot, palette, voice

  
🏗 hardware
PCB, case, BOM, power budget

  
🐍 medusa
Anything tagged for the medusa project umbrella

  
🐛 bug
Crashes, incorrect behavior

  
📋 policy
Legal frame, compliance, brand posture

  
📐 architecture
Design decisions, interfaces

  
📚 docs
External + internal docs

  
📡 rf
Radio + capture + protocol-level work

  
📱 companion
Companion app integration (NearTrace + future)

  
🔐 security
Threat model, lawful-use posture, reviewer pass

No labels
bug
documentation
duplicate
enhancement
good first issue
help wanted
invalid
question
wontfix
⚙ firmware
✨ feature
🎨 brand
🏗 hardware
🐍 medusa
🐛 bug
📋 policy
📐 architecture
📚 docs
📡 rf
📱 companion
🔐 security
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
hartle-tech/medusa#11
No description provided.