Skip to content

Loop 1: docs + doctor + safer hosted adapter errors - #10

Merged
shinyay merged 1 commit into
mainfrom
scenario/loop1-run-prompts
Dec 27, 2025
Merged

shinyay merged 1 commit into
mainfrom
scenario/loop1-run-prompts

Conversation

@shinyay

@shinyay shinyay commented Dec 27, 2025

Copy link
Copy Markdown
Owner

Summary

This PR lands the “loop 1” workshop improvements from scenario/loop1-run-prompts into main.

Key outcomes:

  • Adds a hosted adapter smoke-test note to the README (optional but practical).
  • Adds a triage-assistant doctor command for configuration diagnosis (without leaking secrets).
  • Improves hosted adapter error messages to be more actionable and secret-safe.
  • Improves local triage-assistant eval Markdown report (failure patterns + examples).
  • Updates workshop docs to include version/prereq guardrails and evaluation/feedback guidance.

Fixes #9

What changed

  • README.md
    • Add “Hosted adapter smoke-test (optional)” section.
    • Reminds users to keep secrets in env vars / .env and points to docs/providers.md.
  • src/triage_assistant/cli.py
    • Add doctor command.
    • Enhance eval report output (Top failure patterns, Failure examples).
    • Preserve strict contract: triage prints JSON-only to stdout; errors go to stderr.
  • src/triage_assistant/adapters/*
    • More actionable HTTP/network errors for GitHub Models / Foundry / OpenAI-compatible.
    • Avoid token/key leakage in errors.
  • tests/*
    • Add/extend tests for stdout/stderr contract, doctor, report headings, and token leak prevention.
  • docs/workshop/* + reports/eval/README.md
    • Add prerequisites/UI drift guardrails.
    • Add evaluation checklist and feedback-loop closure guidance.

Validation

  • python3 -m pytest -q

Notes

  • No schema contract changes (TriageOutput remains the output contract).
  • Hosted adapters remain optional; default offline path continues to work via dummy.

@shinyay
shinyay merged commit 4119cd4 into main Dec 27, 2025
2 checks passed
@shinyay
shinyay deleted the scenario/loop1-run-prompts branch December 27, 2025 01:09
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.

[Task] Hosted adapter smoke-test note (optional but practical)

1 participant