Files
git.stella-ops.org/docs/modules/advisory-ai/AGENTS.md
master 90c244948a Update AGENTS.md files across multiple modules to standardize task status update instructions and introduce a new document for Secret Leak Detection operations.
- Modified task status update instructions in AGENTS.md files to refer to corresponding sprint files as `/docs/implplan/SPRINT_*.md` instead of `docs/implplan/SPRINTS.md`.
- Added a comprehensive document for Secret Leak Detection operations detailing scope, prerequisites, rule bundle lifecycle, enabling the analyzer, policy patterns, observability, troubleshooting, and references.
2025-11-05 11:58:32 +02:00

1.8 KiB

Advisory AI agent guide

Mission

Advisory AI is the retrieval-augmented assistant that synthesizes advisory and VEX evidence into operator-ready summaries, conflict explanations, and remediation plans with strict provenance.

Key docs

How to get started

  1. Review ./architecture.md for retrieval pipeline, guardrails, and profile support.
  2. Open correspoding sprint file /docs/implplan/SPRINT_*.md and locate stories for this component.
  3. Check ./TASKS.md and update status before/after work.
  4. Read README/architecture for design context and update as the implementation evolves.

Guardrails

  • Uphold Aggregation-Only Contract boundaries when consuming ingestion data.
  • Preserve determinism and provenance in all derived outputs.
  • Document offline/air-gap pathways for any new feature.
  • Update telemetry/observability assets alongside feature work.

Required Reading

  • docs/modules/advisory-ai/README.md
  • docs/modules/advisory-ai/architecture.md
  • docs/modules/advisory-ai/implementation_plan.md
  • docs/modules/platform/architecture-overview.md

Working Agreement

    1. Update task status to DOING/DONE in both correspoding sprint file /docs/implplan/SPRINT_*.md and the local TASKS.md when you start or finish work.
    1. Review this charter and the Required Reading documents before coding; confirm prerequisites are met.
    1. Keep changes deterministic (stable ordering, timestamps, hashes) and align with offline/air-gap expectations.
    1. Coordinate doc updates, tests, and cross-guild communication whenever contracts or workflows change.
    1. Revert to TODO if you pause the task without shipping changes; leave notes in commit/PR descriptions for context.