improve opening of the README#106
Merged
sourcehawk merged 1 commit intomainfrom Apr 2, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the README introduction to better explain the framework’s purpose and how it helps keep Kubernetes operators maintainable as they scale, focusing on the component and resource-primitive mental model.
Changes:
- Rewrites the opening description to emphasize maintainability, reuse, and “thin controllers”.
- Removes the earlier “three composable layers” bullets and reframes the “Mental Model” section.
- Tweaks the mental model presentation (diagram/table) to align with the new narrative (but currently introduces an inconsistency noted in comments).
Comment on lines
22
to
33
| @@ -35,7 +31,6 @@ Controller | |||
| | **Controller** | Determines which components should exist; orchestrates reconciliation at a high level | | |||
| | **Component** | Represents one logical feature; reconciles its resources and reports a single condition | | |||
| | **Resource Primitive** | Encapsulates desired state and lifecycle behavior for a single Kubernetes object | | |||
There was a problem hiding this comment.
The Mental Model diagram includes a “Kubernetes Object” layer, but the responsibility table no longer includes a matching row. This makes the section inconsistent and can confuse readers; either add the Kubernetes Object row back (as before) or remove it from the diagram / adjust the intro wording so both representations align.
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
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.
No description provided.