Documentation and Developer Experience #12

Objective

Enable developers to install, initialize, and start using the AgentOps Toolkit with GitHub Copilot across different environments in under 10 minutes.

Scope

Human-facing documentation covering quick setup, CLI usage, Copilot integration, and core concepts across common developer environments.

Tasks

• Add Quick Install section using pip

• Provide:

  • Install instructions
  • Upgrade instructions
  • Uninstall instructions

• Document different usage paths:

  • Local CLI usage
  • Usage inside an existing project
  • Usage with GitHub Copilot (VS Code / CLI)

• Document agentops init and generated files

• Add Quickstart:

  • Clone repo (or use existing repo)
  • Install toolkit
  • Run evaluation example

• Document required tools:

  • VS Code + GitHub Copilot
  • Copilot CLI (if applicable)

• Explain GitHub Copilot behavior in the repository:

  • How it discovers instructions
  • When it suggests AgentOps commands

• Provide usage examples for:

  • VS Code (Copilot chat + inline)
  • Copilot CLI workflows

• Add Concepts section:

  • What is a bundle
  • What is normalized output
  • How thresholds work

Acceptance Criteria

• A new developer can choose a setup path (CLI or Copilot) and run an example in under 10 minutes
• Documentation clearly separates different usage scenarios
• No undocumented required steps
• Copilot behavior and expectations are clearly explained
• Examples are simple and easy to follow

Out of Scope

• Advanced scenarios
• Deep technical reference
• Observability documentation
• Advanced architecture diagrams