Skip to content

docs: align README with public specification - #22

Merged
abdalrahmanattya merged 1 commit into
mainfrom
docs/readme-spec-alignment
Aug 12, 2026
Merged

docs: align README with public specification#22
abdalrahmanattya merged 1 commit into
mainfrom
docs/readme-spec-alignment

Conversation

@abdalrahmanattya

Copy link
Copy Markdown
Owner

Summary

  • Make README the self-contained public entry point.
  • Clarify what the service is, what it does, end-to-end GitOps flow, exact local usage, verified release status, safety boundaries, and non-goals.
  • Remove internal project/learner/roadmap framing while preserving accurate architecture links and technical details.

Verification

  • ./scripts/test-overlays.sh
  • ./scripts/check-public-secrets.sh
  • xmllint --noout docs/architecture.svg
  • README local-link audit
  • git diff --check

README.md is the only changed file.

@abdalrahmanattya
abdalrahmanattya merged commit d0288fd into main Aug 12, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant