Skip to content

Add mdbook documentation with GitHub Pages and PR previews#4

Merged
robtaylor merged 4 commits intomainfrom
docs/mdbook-github-pages
Jan 20, 2026
Merged

Add mdbook documentation with GitHub Pages and PR previews#4
robtaylor merged 4 commits intomainfrom
docs/mdbook-github-pages

Conversation

@robtaylor
Copy link
Contributor

Summary

  • Fix plugin.json missing hooks field (v0.10.6)
  • Reorganize documentation into docs/ directory
  • Add mdbook for documentation generation
  • Add GitHub Pages deployment workflow
  • Add PR preview workflow

Changes

Bug Fix:

  • Add hooks field to plugin.json (was missing, preventing hooks from loading)

Documentation Reorganization:

  • PROCESS-ARCHITECTURE.mddocs/architecture.md
  • TESTING.mddocs/testing.md (updated for v0.10.x)
  • TODO.mddocs/roadmap.md
  • Delete duplicate .claude-plugin/SKILL.md
  • Add docs/index.md as documentation index

mdbook Setup:

  • book.toml - mdbook configuration
  • docs/SUMMARY.md - navigation structure
  • .github/workflows/pages.yml - deploy on push to main
  • .github/workflows/preview-docs.yml - PR previews

Test Plan

  • PR preview workflow runs and deploys preview
  • After merge, main deploy workflow runs
  • GitHub Pages serves documentation

🤖 Generated with Claude Code

The hooks field was missing, preventing hooks from loading.

Co-developed-by: Claude Code v2.1.12 (claude-opus-4-5-20251101)
- Move PROCESS-ARCHITECTURE.md → docs/architecture.md
- Move TESTING.md → docs/testing.md (updated for v0.10.x)
- Move TODO.md → docs/roadmap.md
- Delete duplicate .claude-plugin/SKILL.md
- Add docs/index.md as documentation index

Co-developed-by: Claude Code v2.1.12 (claude-opus-4-5-20251101)
@github-actions
Copy link

github-actions bot commented Jan 20, 2026

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-01-20 18:28 UTC

- Add book.toml configuration for mdbook
- Add docs/SUMMARY.md for navigation structure
- Add pages.yml workflow for main branch deployment
- Add preview-docs.yml workflow for PR previews
- Add book/ to .gitignore

PR previews deploy to gh-pages branch under pr-preview/pr-{number}/

Co-developed-by: Claude Code v2.1.12 (claude-opus-4-5-20251101)
@robtaylor robtaylor force-pushed the docs/mdbook-github-pages branch from 17ca051 to 17d7e68 Compare January 20, 2026 16:58
Co-developed-by: Claude Code v2.1.12 (claude-opus-4-5-20251101)
@robtaylor robtaylor force-pushed the docs/mdbook-github-pages branch from e0950c1 to b9d6e15 Compare January 20, 2026 18:25
@robtaylor robtaylor merged commit ce37aa3 into main Jan 20, 2026
5 checks passed
@robtaylor robtaylor deleted the docs/mdbook-github-pages branch January 20, 2026 18:28
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