Skip to content

docs: Create comprehensive documentation suite #2

@rianjs

Description

@rianjs

Description

Create the complete documentation architecture following cli-guide.md: exhaustive README, CLAUDE.md for AI agents, CONTRIBUTING.md for developers, and integration-tests.md for manual verification.

Tasks

2.1 Rewrite README.md as exhaustive API reference

  • Add features section
  • Add installation section (Homebrew, Go Install, Binary)
  • Add quick start section
  • Add configuration section with environment variables table
  • Document credential storage (macOS Keychain vs Linux file)
  • Create Command Reference section with every command documented:
    • Global flags table
    • Each command with description, aliases, flags table, examples
  • Add Scripting & Composition section with jq/grep/xargs examples
  • Add Exit Codes table
  • Add Development section
  • Ensure every flag and option is documented

2.2 Create CLAUDE.md

  • Project overview paragraph
  • Commands section (make build/test/lint)
  • Architecture diagram showing file structure
  • Key patterns section:
    • Command factories: NewCmd{Name}() *cobra.Command
    • Options structs for flags
    • Run functions: run{Action}(opts, client) error
    • Client injection pattern
  • Testing philosophy section
  • Issue & PR workflow
  • Release workflow

2.3 Create CONTRIBUTING.md

  • Development setup steps
  • Running tests commands
  • Code style guidelines
  • Conventional commits format
  • Pull request process
  • Project structure overview

2.4 Create integration-tests.md

  • Test environment setup prerequisites
  • Test data conventions ([Test] prefix)
  • Command tests table for each command:
    • apps (list, get, metrics)
    • alerts policies (list, get)
    • config (set-api-key, set-account-id, set-region, show, delete-*)
    • dashboards (list, get)
    • deployments (list, create)
    • entities (search)
    • logs rules (list, create, delete)
    • nerdgraph (query)
    • nrql (query)
    • synthetics (list, get)
    • users (list, get)
  • Edge cases section (unicode, empty results, network timeout, invalid credentials)
  • Test execution checklist

Acceptance Criteria

  • README documents 100% of CLI surface area
  • All examples in README are copy-paste ready and work
  • CLAUDE.md provides enough context for AI agents to work autonomously
  • CONTRIBUTING.md enables new contributors to get started
  • integration-tests.md covers all commands and edge cases

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions