docs: centered README header + Prometheus-style architecture diagram - #204
Merged
Conversation
…diagram style guide - README opens OpenObserve-style: centered KubeAid wordmark (light/dark via picture), italic tagline, project + status badge rows, quick links, then the tightened intro prose. The wordmark pair ships in docs/images. - Architecture diagram redrawn in the classic Prometheus overview style: plain boxes, labelled thin arrows, warm-orange key component (kubeaid-config), blue bulleted info box (KubeAid repo), dashed border around the cluster, stacked rectangles for your applications, grey node-style Cluster API box — with the real Argo CD, Git, KubeAid and Cluster API marks inlined (ids/classes namespaced so nothing collides). The operator's git push starts the loop; Argo CD pulls charts and values from the two repos; the CLI is a runs-once bootstrap. - New CLAUDE.md records the diagram's visual language and light/dark palette swap so future edits keep both variants in sync, plus the content-accuracy rules the docs overhaul established. Signed-off-by: Ashish Jaiswal <ashish@obmondo.com>
ashish1099
marked this pull request as ready for review
August 15, 2026 20:43
ashish1099
added a commit
that referenced
this pull request
Aug 15, 2026
docs: honest roadmap + drop stale AKS autoscaling TODO (missed the #204 merge)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README front door and architecture diagram, per the review at the preview page:
Header (OpenObserve-style)
docs/images/so the README is self-containedArchitecture diagram (Prometheus overview style)
kubeaid-configas the warm-orange key component;KubeAid repoas the blue bulleted info box (charts, vendoring, weekly reviewed PRs, upstream-or-mirror); dashed border around the Kubernetes cluster; Operator starts the loop withgit push; Argo CD pulls charts + values (the real two-source Application); platform stack incl. NetBird + Keycloak; stacked "Your applications"; grey node-style Cluster API box<picture>swaps automaticallyCLAUDE.md (new)
Records the diagram's visual language + palette-swap table so both variants stay in sync, and the content-accuracy rules from the docs overhaul (verify against source; NetBird/Keycloak default; kubeaid-config is the only required repo).