Skip to content

docs: add VitePress documentation site#16

Merged
Goosterhof merged 3 commits into
mainfrom
docs/vitepress-documentation-site
Apr 9, 2026
Merged

docs: add VitePress documentation site#16
Goosterhof merged 3 commits into
mainfrom
docs/vitepress-documentation-site

Conversation

@Goosterhof
Copy link
Copy Markdown
Contributor

Summary

  • Adds a complete VitePress documentation site for packages.script.nl
  • 4 guide pages: home (thesis + quality story), getting started, architecture, contributing
  • 10 package pages with guided tours, progressive disclosure (juniors → experts), and API reference tables
  • Sidebar organized by package tier: Foundation, Services, Domain
  • Deployment via Cloudflare Pages Git integration

Build settings for Cloudflare Pages

Setting Value
Build command npm run docs:build
Build output directory docs/.vitepress/dist
Root directory /
Node version NODE_VERSION=24

Test plan

  • npm run docs:dev — verify local preview
  • npm run docs:build — verify build succeeds
  • Review content accuracy against package source code
  • Create Cloudflare Pages project packages-script-nl
  • Configure DNS for packages.script.nl

🤖 Generated with Claude Code

Goosterhof and others added 3 commits April 9, 2026 14:37
Adds a complete documentation site with architecture thesis, getting started
guide, contributing guide, and guided tour pages for all 10 packages.

- VitePress config with sidebar organized by Foundation / Services / Domain
- Home page with package catalog and quality guarantee overview
- Architecture page explaining factory pattern, loose coupling, middleware
- Getting started guide with composition examples
- Contributing guide with 8-gate CI pipeline walkthrough
- 10 package pages: http, storage, helpers, theme, loading, toast, dialog,
  translation, adapter-store, router
- Build scripts: docs:dev, docs:build, docs:preview

Deployment via Cloudflare Pages Git integration (not CI push).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Resolves npm audit vulnerability in esbuild <=0.24.2 (GHSA-67mh-4wv8-2f99).
VitePress 1.6.4 was pinned to vulnerable vite/esbuild — no stable fix available,
2.0 alpha bundles vite 7 with patched esbuild.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Goosterhof Goosterhof merged commit 257eb7c into main Apr 9, 2026
1 check passed
@Goosterhof Goosterhof deleted the docs/vitepress-documentation-site branch April 9, 2026 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant