Skip to content

docs: fix README inconsistencies and add controller comparison#50

Merged
y0s3ph merged 1 commit into
mainfrom
docs/readme-consistency
Mar 10, 2026
Merged

docs: fix README inconsistencies and add controller comparison#50
y0s3ph merged 1 commit into
mainfrom
docs/readme-consistency

Conversation

@y0s3ph

@y0s3ph y0s3ph commented Mar 10, 2026

Copy link
Copy Markdown
Owner

Summary

  • Neutralized Quick Start comment to not mention ArgoCD explicitly (install the controller instead of install ArgoCD)
  • Neutralized "What It Sets Up" section for balanced controller framing (ArgoCD or Flux CD — your choice)
  • Removed redundant "Interactive Wizard Flow (Planned)" section — its content was already covered in the Quick Start section and the "(Planned)" label was outdated
  • Added ArgoCD vs Flux comparison table under Design Decisions (incorporates content from docs: add ArgoCD vs Flux comparison table #49)
  • Updated Table of Contents with the new comparison section

Supersedes #49.

Test plan

  • Verify README renders correctly on GitHub
  • Verify no broken ToC links
  • Verify ArgoCD vs Flux comparison table displays correctly

- Neutralize Quick Start comment to not mention ArgoCD explicitly
- Neutralize "What It Sets Up" section for balanced controller framing
- Remove redundant "Interactive Wizard Flow (Planned)" section (content
  already covered in Quick Start)
- Add ArgoCD vs Flux comparison table under Design Decisions
- Update Table of Contents with new section
@y0s3ph y0s3ph self-assigned this Mar 10, 2026
@y0s3ph y0s3ph merged commit 622720c into main Mar 10, 2026
3 checks passed
@y0s3ph y0s3ph deleted the docs/readme-consistency branch March 10, 2026 15:40
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