Skip to content

chore(docs): add Docusaurus documentation site with GitHub Pages deployment#204

Merged
steilerDev merged 10 commits into
betafrom
chore/200-docs-site
Feb 23, 2026
Merged

chore(docs): add Docusaurus documentation site with GitHub Pages deployment#204
steilerDev merged 10 commits into
betafrom
chore/200-docs-site

Conversation

@steilerDev
Copy link
Copy Markdown
Owner

@steilerDev steilerDev commented Feb 23, 2026

Summary

  • New docs/ workspace (@cornerstone/docs): Docusaurus 3.9.2 (Webpack-based, no native binaries) with 22 content pages across Guides and Development sidebars
  • GitHub Pages CI workflow (.github/workflows/docs.yml): builds and deploys to https://steilerDev.github.io/cornerstone/ on every push to main that touches docs/**
  • Playwright screenshot capture (e2e/tests/screenshots/): seeds sample data, captures light/dark mode screenshots of all implemented pages, saves to docs/static/img/screenshots/
  • README.md slimmed down to a lean pointer linking to the docs site, with a compact feature list and quick-start command
  • docs-writer agent rewritten to own the docs site as its primary artifact, with README.md as secondary
  • CLAUDE.md updated with docs workspace, new commands, delegation updates, and a Documentation Site section

Documentation Structure

docs/src/
  intro.md                          # Landing page (slug: /)
  roadmap.md                        # Epic checklist with GitHub Issue links
  getting-started/                  # Docker setup, first login, env vars
  guides/
    work-items/                     # CRUD, tags, notes/subtasks, dependencies, shortcuts
    users/                          # OIDC setup, admin panel
    budget/                         # Placeholder (feature in development)
    appearance/                     # Dark mode
  development/
    agentic/                        # Agent team (10 agents), workflow, setup
    tech-stack.md                   # Stack table + ADR links

Technical Notes

  • React 18.3.1 pinned in docs workspace (Docusaurus 3.9.2 SSG incompatible with React 19.x hoisted from client workspace)
  • docs/** excluded from project ESLint and Prettier (Docusaurus has its own TS/JSX setup)
  • docs/.docusaurus/ added to .gitignore (build cache)
  • Dockerfile updated: COPY docs/package.json docs/ added to both builder and prod stages so npm workspace graph resolves correctly
  • Application build (npm run build) unchanged — docs workspace is standalone and not included

Test Plan

  • CI Quality Gates and Docker checks pass
  • docs.yml workflow builds successfully on GitHub Actions (validates npm run docs:build)
  • PR diff: no regressions in existing workspaces
  • Screenshot capture: npm run docs:screenshots works after npm install

Closes #200

🤖 Generated with Claude Code

claude added 10 commits February 23, 2026 08:59
@claude
chore(docs): add Docusaurus documentation site with GitHub Pages depl…
f0e1fae 
…oyment

Sets up a complete @cornerstone/docs workspace using Docusaurus 3.9.2 (Webpack-
based, no esbuild/SWC native binaries) deployed to GitHub Pages via a dedicated
CI workflow.

- docs/ workspace: package.json, docusaurus.config.js, sidebars.js, tsconfig.json
- docs/src/: 22 Markdown content pages across Guides and Development sidebars
  - Getting started (Docker setup, first login, configuration/env vars)
  - Work items (CRUD, tags, notes/subtasks, dependencies, keyboard shortcuts)
  - Users & auth (OIDC setup, admin panel)
  - Budget (placeholder with under-development notice)
  - Appearance (dark mode)
  - Roadmap (epic checklist with issue links)
  - Development (agentic process, 10-agent team, workflow, tech stack)
- docs/static/: brand assets (logo.svg, favicon.svg), screenshots placeholder
- docs/theme/custom.css: Cornerstone brand colors (blue-500 primary)
- .github/workflows/docs.yml: builds and deploys to GitHub Pages on push to main
- e2e/tests/screenshots/: Playwright screenshot capture script (seeds sample data,
  captures light/dark mode screenshots of all implemented pages)
- README.md: slimmed down to lean pointer linking to docs site
- .claude/agents/docs-writer.md: rewritten to own docs/ site as primary artifact
- CLAUDE.md: updated agent table, project structure, delegation list, commands,
  added Documentation Site section
- package.json: added docs workspace, docs:dev, docs:build, docs:screenshots scripts
- eslint.config.js: added docs/** to global ignores
- .prettierignore: added docs/
- .gitignore: added docs/.docusaurus/
- Dockerfile: added COPY docs/package.json docs/ in both builder and prod stages

Fixes #200

Co-Authored-By: Claude docs-writer (Sonnet 4.6) <noreply@anthropic.com>
@claude
ci: trigger quality gates
b2e477c
@claude
chore(docs): merge origin/beta into chore/200-docs-site
f08c88e 
Resolves merge conflicts between docs site implementation (chore/200-docs-site)
and beta branch changes (EPIC-05 budget rework, worktree isolation, e2e smoke CI):

- CLAUDE.md: merged 10-agent team with Session Isolation, Post-merge E2E,
  and e2e:smoke command from beta; kept docs-writer delegation and docs site section
- README.md: kept compact feature list (lean pointer approach)
- e2e/package.json: combined test:smoke from beta with screenshots from HEAD
- package-lock.json: regenerated with all workspaces (beta base + docs workspace)
- .claude/agents/docs-writer.md: kept HEAD version (beta deleted it)

Co-Authored-By: Claude orchestrator (Sonnet 4.6) <noreply@anthropic.com>
@claude
style(docs): apply prettier formatting to markdown files
d38ed73 
Fix format:check CI failure on CLAUDE.md, README.md, and docs-writer.md
after merge conflict resolution introduced unformatted content.

Co-Authored-By: Claude orchestrator (Sonnet 4.6) <noreply@anthropic.com>
@claude
ci(docs): add feature branch trigger for build verification
b80f551 
Temporarily adds chore/200-docs-site to the docs.yml push trigger so the
Docusaurus build can be verified in CI before merging. Deploy job is
guarded by github.ref check and will only run from main.

Will be reverted once build is confirmed.

Co-Authored-By: Claude orchestrator (Sonnet 4.6) <noreply@anthropic.com>
@claude
ci: trigger docs build verification
901b959
@claude
ci(docs): remove path filter for feature branch verification
e39ab6a
@claude
fix(docs): correct Prism language name dockerfile -> docker
73612f0 
prism-react-renderer uses 'docker' not 'dockerfile' as the language
identifier. This caused the SSG phase of docusaurus build to fail with
Cannot find module './prism-dockerfile'.

Co-Authored-By: Claude docs-writer (Sonnet 4.6) <noreply@anthropic.com>
@claude
fix(docs): fix broken links in first-login and budget pages
a516d0b 
- first-login.md: correct relative links to admin-panel and oidc-setup
  (they live under /guides/users/, not /getting-started/)
- budget/index.md: fix ../roadmap -> /roadmap (roadmap is at site root,
  not in /guides/)

Co-Authored-By: Claude docs-writer (Sonnet 4.6) <noreply@anthropic.com>
@claude
ci(docs): restore final docs.yml trigger (main-only with paths filter)
5483a75 
Removes temporary feature branch trigger used for build verification.
Docusaurus build confirmed passing in CI (run #22301120576).

Co-Authored-By: Claude orchestrator (Sonnet 4.6) <noreply@anthropic.com>
@steilerDev steilerDev merged commit 8bd2b9b into beta Feb 23, 2026
5 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

ghost commented Feb 23, 2026

🎉 This PR is included in version 1.9.0-beta.45 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

steilerDev pushed a commit that referenced this pull request Feb 23, 2026
@claude
docs(budget): add budget management user guides and README updates
25f0ea9 
Documentation site guides for budget categories, vendors, invoices,
financing sources, subsidy programs, and budget overview. README updated
with Budget Management feature section and roadmap. (#204, #214)
@steilerDev steilerDev deleted the chore/200-docs-site branch March 7, 2026 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@steilerDev @claude