Skip to content
This repository was archived by the owner on Apr 15, 2026. It is now read-only.

docs: initialize Docusaurus documentation site#28

Merged
jmgilman merged 12 commits intomasterfrom
docs/docusaurus-setup
Jan 2, 2026
Merged

docs: initialize Docusaurus documentation site#28
jmgilman merged 12 commits intomasterfrom
docs/docusaurus-setup

Conversation

@jmgilman
Copy link
Copy Markdown
Collaborator

@jmgilman jmgilman commented Jan 2, 2026

Summary

  • Initialize Docusaurus documentation site with Diataxis methodology
  • Migrate existing ADRs to new structure with proper frontmatter
  • Create stub files for all planned documentation pages
  • Write comprehensive landing page with project overview
  • Configure Cloudflare Pages deployment with caching headers

Documentation Structure

Category Pages
Tutorials 4 (getting started, first task, parallel agents, custom image)
How-to Guides 15 (install, auth, spawning, management)
Reference 19 (CLI commands, config, images)
Explanation 8 (architecture, concepts)
Decisions (ADRs) 6 migrated with index page

Test plan

  • Verify Cloudflare Pages preview build succeeds
  • Check landing page renders correctly
  • Verify sidebar navigation works
  • Confirm ADRs display properly

🤖 Generated with Claude Code

jmgilman and others added 3 commits January 1, 2026 20:20
Set up documentation site using Docusaurus with the Diataxis
methodology (Tutorials, How-to Guides, Reference, Explanation).

- Configure Docusaurus for docs-only mode at root path
- Migrate ADRs to docs/docs/decisions/ with frontmatter
- Create stub files for all planned documentation pages
- Remove old design documents (content to be extracted)
- Set up sidebar navigation with collapsible categories

Structure includes:
- 4 tutorials (getting started, first task, parallel agents, custom image)
- 15 how-to guides (install, auth, spawning, management)
- 19 reference pages (CLI commands, config, images)
- 8 explanation pages (architecture, concepts)
- 6 ADRs with index page

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Add comprehensive intro.md landing page including:
- Project description and value proposition
- Key concepts (Instance, Session, Agent)
- Quick usage examples
- Links to Getting Started tutorial and CLI Reference

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Configure caching and security headers for Cloudflare Pages:
- Aggressive caching for versioned assets (1 year, immutable)
- Week-long caching for images
- Security headers (nosniff, DENY framing, strict referrer)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Jan 2, 2026

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
headjack 44de801 Commit Preview URL

Branch Preview URL
Jan 02 2026, 07:19 PM

jmgilman and others added 9 commits January 1, 2026 20:41
Configure wrangler.jsonc to point to the build directory for
static asset deployment via Cloudflare Workers Builds.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Write comprehensive documentation using Diataxis methodology:

Tutorials (4 pages):
- Getting started, first coding task, parallel agents, custom images

How-To Guides (8 pages, consolidated from 15):
- Install, authenticate (combined 3 agent guides), manage sessions
  (combined 4 guides), stop/cleanup, recover from crash, build custom
  images (combined 2 guides), troubleshoot auth

Reference (17 pages):
- All CLI commands, configuration, environment, storage, image overview
  and labels

Explanation (8 pages):
- Architecture, isolation model, CLI agents vs API, worktree strategy,
  session lifecycle, authentication, image customization, version managers

Also fix bug in run.go where --agent flag help text was unclear.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@jmgilman jmgilman merged commit 5c42742 into master Jan 2, 2026
2 checks passed
@jmgilman jmgilman deleted the docs/docusaurus-setup branch January 2, 2026 19:23
jmgilman added a commit that referenced this pull request Jan 3, 2026
Current behavior:
N/A - new feature

New behavior:
Complete documentation site using Docusaurus with Diataxis methodology including tutorials, how-to guides, reference pages, and architectural explanations. Includes comprehensive content for all CLI commands, configuration options, and development workflows with Cloudflare Pages deployment configuration.

Closes: #28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant