stella-ops.org/git.stella-ops.org
1
0
Fork 0
Code Issues Pull Requests Actions 2 Releases Wiki Activity
Files
22390057fca89776bf376bf972e67dbe1365bdbd
git.stella-ops.org/src/DevPortal/StellaOps.DevPortal.Site/AGENTS.md
StellaOps Bot 22390057fc stop syncing with TASKS.md
2025-12-26 11:44:40 +02:00

1.6 KiB
Raw Blame History

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 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.
    1. Use npm run build:offline, npm run test:a11y, npm run lint:links, and npm run budget:dist on a fast (non-NTFS) volume before shipping DevPortal changes; ensure npm run sync:spec ran first.