Skip to content

docs: update README and AGENTS.md#148

Merged
betegon merged 1 commit intomainfrom
docs/update-readme-and-agents
Jan 31, 2026
Merged

docs: update README and AGENTS.md#148
betegon merged 1 commit intomainfrom
docs/update-readme-and-agents

Conversation

@betegon
Copy link
Member

@betegon betegon commented Jan 31, 2026

closes #46

Summary

Rewrites the README to be user-focused with a clear separation between usage and development. Updates AGENTS.md with project goals and accurate architecture documentation.

Changes

README.md

  • Adds banner image at the top
  • Prioritizes curl install script as the recommended method
  • Highlights key features: DSN auto-detection, Seer AI integration, monorepo support
  • Includes commands table with all command groups
  • Separates development section at the bottom
  • Links to cli.sentry.dev for full documentation

AGENTS.md

  • Adds project overview with goals and key features
  • Updates architecture section with complete directory structure:
    • lib/db/ - SQLite database layer
    • lib/dsn/ - DSN detection with language support
    • lib/formatters/ - Output formatting
  • Updates file locations table with Seer types and DSN language paths

Test plan

Visual review - these are documentation-only changes.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 31, 2026

Semver Impact of This PR

🟢 Patch (bug fixes)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).


Bug Fixes 🐛

  • (telemetry) Capture command errors to Sentry by betegon in #145

Documentation 📚

  • Update README and AGENTS.md by betegon in #148

🤖 This preview updates automatically when you update the PR.

@betegon betegon marked this pull request as ready for review January 31, 2026 23:16
@betegon betegon merged commit 1f7f02a into main Jan 31, 2026
19 checks passed
@betegon betegon deleted the docs/update-readme-and-agents branch January 31, 2026 23:18
- **AI-powered debugging** - Integrate Seer AI for root cause analysis and fix plans
- **Developer-friendly** - Follow `gh` CLI conventions for intuitive UX
- **Agent-friendly** - JSON output and predictable behavior for AI coding agents
- **Fast** - Native binaries via Bun, SQLite caching for API responses
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Fast** - Native binaries via Bun, SQLite caching for API responses
- **Fast** - Native binaries via Bun

We do NOT cache API responses at all 😅

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.

docs: Update README for V0 release

2 participants