Skip to content

Add spec structure and architecture documentation#27

Open
xrajesh wants to merge 1 commit into
openshift:mainfrom
xrajesh:xav/2026-05-30
Open

Add spec structure and architecture documentation#27
xrajesh wants to merge 1 commit into
openshift:mainfrom
xrajesh:xav/2026-05-30

Conversation

@xrajesh
Copy link
Copy Markdown

@xrajesh xrajesh commented May 30, 2026

Summary

  • Add .ai/spec/ structure with behavioral specs (what/) and codebase navigation (how/) optimized for AI agent comprehension
  • Add ARCHITECTURE.md with Mermaid diagrams covering system context, proposal workflow, CRD relationships, and plugin architecture
  • Update AGENTS.md with pointer to the spec structure

what/ (behavioral rules)

  • system-overview.md — plugin role, API contract, CRD inventory, constraints
  • proposal-lifecycle.md — phase derivation, approval flows, sandbox logs, refine/escalate
  • configuration.md — approval policy, LLM providers, agents management
  • dynamic-components.md — adapter component registry and rendering rules

how/ (codebase navigation)

  • project-structure.md — module map, entry points, naming conventions
  • k8s-data-layer.md — watch patterns, result CR correlation, approval patch generation, log streaming
  • console-plugin-system.md — module federation, extension registration, build config

Test plan

  • Verify spec files are accurate against current codebase
  • Verify ARCHITECTURE.md Mermaid diagrams render correctly on GitHub
  • Confirm no functional code changes (documentation only)

🤖 Generated with Claude Code

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>
@openshift-ci openshift-ci Bot requested review from DavidHurta and wking May 30, 2026 19:31
@kyoto
Copy link
Copy Markdown
Member

kyoto commented Jun 2, 2026

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Jun 2, 2026
@xrajesh
Copy link
Copy Markdown
Author

xrajesh commented Jun 3, 2026

/approve

@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented Jun 3, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: xrajesh
Once this PR has been reviewed and has the lgtm label, please assign davidhurta for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm Indicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants