Add spec structure and architecture documentation#27
Open
xrajesh wants to merge 1 commit into
Open
Conversation
what/: system-overview.md, proposal-lifecycle.md, configuration.md, dynamic-components.md how/: project-structure.md, k8s-data-layer.md, console-plugin-system.md ARCHITECTURE.md: human-facing overview with Mermaid diagrams Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Member
|
/lgtm |
Author
|
/approve |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: xrajesh The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
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.
Summary
.ai/spec/structure with behavioral specs (what/) and codebase navigation (how/) optimized for AI agent comprehensionARCHITECTURE.mdwith Mermaid diagrams covering system context, proposal workflow, CRD relationships, and plugin architectureAGENTS.mdwith pointer to the spec structurewhat/ (behavioral rules)
system-overview.md— plugin role, API contract, CRD inventory, constraintsproposal-lifecycle.md— phase derivation, approval flows, sandbox logs, refine/escalateconfiguration.md— approval policy, LLM providers, agents managementdynamic-components.md— adapter component registry and rendering ruleshow/ (codebase navigation)
project-structure.md— module map, entry points, naming conventionsk8s-data-layer.md— watch patterns, result CR correlation, approval patch generation, log streamingconsole-plugin-system.md— module federation, extension registration, build configTest plan
🤖 Generated with Claude Code