feat: Add guild charters and task boards for various components
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
- Introduced guild charters for Scanner Deno, PHP, Ruby, Native, WebService, Java, Surface.Env, Surface.FS, Surface.Secrets, Surface.Validation, UI, Zastava Observer, Zastava Webhook, Zastava Core, and Plugin Platform. - Each charter outlines the mission, scope, required reading, and working agreements for the respective guilds. - Created task boards for Surface.Env, Surface.FS, Surface.Secrets, Surface.Validation, and Zastava components to track progress and dependencies. - Ensured all documents emphasize determinism, offline readiness, security, and integration with shared Surface libraries.
This commit is contained in:
@@ -1,15 +1,26 @@
|
||||
# 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.
|
||||
# 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 `docs/implplan/SPRINTS.md` and the local `TASKS.md` when you start or finish work.
|
||||
- 2. Review this charter and the Required Reading documents before coding; confirm prerequisites are met.
|
||||
- 3. Keep changes deterministic (stable ordering, timestamps, hashes) and align with offline/air-gap expectations.
|
||||
- 4. Coordinate doc updates, tests, and cross-guild communication whenever contracts or workflows change.
|
||||
- 5. Revert to `TODO` if you pause the task without shipping changes; leave notes in commit/PR descriptions for context.
|
||||
|
||||
Reference in New Issue
Block a user