feat(docs): update architecture and state machines documentation - #938
Open
nlevee wants to merge 6 commits into
Open
feat(docs): update architecture and state machines documentation#938nlevee wants to merge 6 commits into
nlevee wants to merge 6 commits into
Conversation
nlevee
commented
Jul 10, 2026
nlevee
commented
Contributor
- Refactor architecture documentation to consolidate controller state machine information.
- Add detailed state machines documentation for CRDs, including transitions and conditions.
- Include state machines in the navigation of the operator manual.
- Update requirements.txt for dependency management.
- Modify mkdocs configuration to support Mermaid diagrams.
- Refactor architecture documentation to consolidate controller state machine information. - Add detailed state machines documentation for CRDs, including transitions and conditions. - Include state machines in the navigation of the operator manual. - Update requirements.txt for dependency management. - Modify mkdocs configuration to support Mermaid diagrams.
corrieriluca
requested changes
Jul 10, 2026
| stateDiagram-v2 | ||
| [*] --> Idle | ||
| Idle --> PlanNeeded: plan outdated / new relevant commit / sync scheduled | ||
| Idle --> ApplyNeeded: plan up to date but apply needed (autoApply on) |
Member
There was a problem hiding this comment.
if I'm not wrong, Idle --> ApplyNeeded is not possible 🤔
The layer should transition from PlanNeeded to ApplyNeeded if the plan contains a drift.
Do you confirm?
Comment on lines
+55
to
+56
| PlanNeeded --> Idle: TerraformRun (plan) created — run in flight | ||
| ApplyNeeded --> Idle: TerraformRun (apply) created — run in flight |
Member
There was a problem hiding this comment.
If i'm not wrong, these conditions are not possible, the layer stays in PlanNeeded when a plan is running, and ApplyNeeded when a apply is running
Switch the docs toolchain from pip to uv, in CI (docs.yaml) and locally via mise.toml (aligned with the worktree-docs-contributing-tools branch). Declare the mermaid2 plugin (with search) in mkdocs.yml so the state machine diagrams actually render. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Refactored the changes section by eliminating empty code-changes tags to improve readability and maintainability of the codebase.
Inline the CRD state machine diagrams and prose into the architecture "Controller state machines" section and drop the dedicated state-machines.md page (and its nav entry). Update the controllers AGENTS.md pointer and switch the mise install task to `uv sync`. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
Author
|
@copilot resolve the merge conflicts in this pull request |
Merge conflicts have been resolved in commit
|
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.