Files
git.stella-ops.org/src/DevPortal/StellaOps.DevPortal.Site/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.4 KiB

Developer Portal Guild Charter

Mission

Deliver the StellaOps developer portal with interactive API reference, SDK documentation, runnable examples, and offline export capability.

Scope

  • Static site generator integrating OpenAPI specs, code examples, and SDK docs.
  • Search, schema diagrams, try-it console (non-prod), copy-curl snippets.
  • Version selector for API major versions and changelog integration.
  • Offline bundle build compatible with air-gapped environments.

Definition of Done

  • Portal rebuilds deterministically from specs/examples; CI publishes artifacts.
  • Search, schema visuals, examples verified via automated tests.
  • Offline bundle renders without external dependencies.

Required Reading

  • docs/modules/platform/architecture.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.