Add getting up and running docs · Issue #213 · demml/scouter · GitHub
Skip to content

Add getting up and running docs #213

Open

Description

@thorrester

Scouter currently lacks clear getting started documentation, making it difficult for new developers to get up and running quickly.

Tasks

  • Write a "Getting Started" guide covering installation, basic setup, and first use
  • Document how to spin up the local server (Docker backends + make start.server)
  • Add a quickstart example for each core feature: drift detection (PSI/SPC/custom), tracing, and GenAI evaluation
  • Document environment variables required for the server
  • Add a section on the Python client (ScouterClient, Drifter, ScouterQueue)
  • Ensure docs are linked from the README

Notes

  • Target audience: developers new to Scouter who want to integrate it into an ML workflow
  • Should cover both the Python client and the self-hosted server setup

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions