stella-ops.org/git.stella-ops.org
1
0
Fork 0
Code Issues Pull Requests Actions 1 Releases Wiki Activity
Files
3aed135fb5e5791efcbe3399084e5e88f1ad0083
git.stella-ops.org/StellaOps.Authority.TODOS.Docs.md

2.5 KiB
Raw Blame History

StellaOps Authority — Docs & Enablement Plan

Read first: AGENTS.md, StellaOps.Authority.TODOS.md, and this plan. Keep progress synchronized across trackers.

Mission

Produce operator and developer documentation for the new Authority stack, including configuration guides, API references, plugin tutorials, migration playbooks, and release notes.

Task Pipeline

Order Task IDs Description Dependencies Acceptance
1 DOC1 Draft docs/11_AUTHORITY.md (architecture overview, configuration, plugin model, deployment scenarios). FND4, CORE1 Reviewed by DevEx + Authority Core.
2 DOC2 Generate API reference snippets for /token, /jwks, /introspect, /revoke (OpenAPI fragment + human-readable table). CORE2, LIB4 Linked from docs + README.
3 DOC3 Write migration guide for Feedser moving from anonymous to secured mode (staged rollout, config updates). FSR1–FSR3 Includes rollback plan + FAQ.
4 DOC4 Create plugin developer how-to (leveraging Plugin Team notes) covering packaging, capability flags, logging. PLG1–PLG6 READY FOR DOCS REVIEW (2025-10-10) – docs/dev/31_AUTHORITY_PLUGIN_DEVELOPER_GUIDE.md aligned with PLG6 scope; pending Docs copy-edit, diagram export, and LDAP RFC cross-linking.
5 DOC5 Update root README, quickstarts (docs/10_FEEDSER_CLI_QUICKSTART.md), CLI help text references. CLI4, FSR4 Make sure new links validated.
6 Cross Collaborate on inline XML docs for public APIs across libraries. LIB1–LIB5 Ensure DocFX/IntelliSense friendly summaries.

Implementation Notes

  • Maintain offline-friendly instructions (no implicit internet requirements).
  • Highlight security-critical steps (bootstrap credentials, key rotation) in callouts.
  • Include environment-variable tables for configuration.
  • Provide diagrams where useful (architecture, plugin flow).
  • Prepare release note entry summarizing Authority MVP deliverables and upgrade steps.

Deliverables

  • New documentation pages + updated existing guides.
  • OpenAPI snippet (JSON/YAML) committed to repo.
  • Migration checklist for operators.
  • Plugin developer tutorial ready for community/internal teams.

Coordination

  • Attend cross-team syncs to capture latest API contracts.
  • Request reviews from respective teams (Authority Core, Plugin, CLI, Security).
  • Work with DevEx to ensure docs packaged in Offline Kit if applicable.
  • Update docs as soon as breaking changes occur—subscribe to relevant PRs.