Skip to content

Conversation

@dcramer
Copy link
Member

@dcramer dcramer commented Jan 10, 2026

Add a comprehensive documentation site for Abacus using Astro Starlight,
deployed to GitHub Pages at https://getsentry.github.io/abacus.

The README has grown large and makes it difficult to find specific
information. A dedicated docs site provides better navigation, search,
and organization for setup guides, provider configuration, and CLI
reference.

Structure:

  • Getting Started: Quick start, local development, environment variables
  • Providers: Claude Code, Cursor, GitHub commits configuration
  • CLI Reference: Usage data, commit data, identity mappings, database commands
  • Deployment: Vercel setup with cron job configuration
  • Development: Architecture overview and guide for adding new providers

Also includes:

  • GitHub Actions workflow for automatic deployment on push to main
  • write-docs skill for maintaining documentation consistency
  • Documentation sync table in AGENTS.md to remind about keeping docs current

After merging, GitHub Pages needs to be enabled in repository settings
(Settings → Pages → Source: GitHub Actions) for deployment to work.

🤖 Generated with Claude Code

Create a comprehensive documentation site deployed to GitHub Pages
using Astro Starlight. The site covers setup guides, provider
configuration, CLI reference, and deployment instructions.

Structure:
- Getting Started: Quick start, local dev, environment variables
- Providers: Claude Code, Cursor, GitHub commits setup
- CLI Reference: Usage data, commit data, identity mappings, database
- Deployment: Vercel configuration with cron jobs
- Development: Architecture and adding providers guide

Also adds:
- GitHub Actions workflow for automatic deployment
- write-docs skill for maintaining documentation
- Documentation sync table in AGENTS.md
- Excludes docs/ from root tsconfig (Astro handles its own TS)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@dcramer dcramer merged commit 286ed0b into main Jan 10, 2026
11 checks passed
@dcramer dcramer deleted the docs-site branch January 10, 2026 01:08
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.

2 participants