Skip to content

Add agentic documentation foundation and domain knowledge#1

Closed
Prashanth684 wants to merge 120 commits into
masterfrom
agentic-docs-foundation-domain
Closed

Add agentic documentation foundation and domain knowledge#1
Prashanth684 wants to merge 120 commits into
masterfrom
agentic-docs-foundation-domain

Conversation

@Prashanth684

Copy link
Copy Markdown
Owner

Summary

First PR in a series to add AI-assisted development documentation to the enhancements repo. This PR combines the foundation (navigation framework) with core platform domain knowledge.

This is a focused subset of openshift#1992, broken down as requested to enable incremental review and merge.

What's Included

Foundation & Navigation (PR 1)

  • AGENTS.md: Task-based navigation index for AI agents
    • Common workflows (writing enhancements, building operators, API evolution)
    • Role-based quick start guides
    • Prevents hallucination by directing agents to current docs
  • CLAUDE.md: Symlink for AI compatibility
  • ai-docs/DESIGN_PHILOSOPHY.md: Core OpenShift design principles
  • ai-docs/KNOWLEDGE_GRAPH.md: Visual concept map showing documentation relationships
  • ai-docs/references/: Glossary and reference index

Domain Knowledge (PR 2)

  • ai-docs/domain/kubernetes/: Pod, Service, CRD patterns and conventions
  • ai-docs/domain/openshift/: ClusterOperator and ClusterVersion API deep dives

Why These Together?

Foundation sets up the "why" and navigation system, while domain knowledge provides the "what" that navigation points to. They're tightly coupled and small enough to review as one unit (~2,100 lines).

What's NOT Included (Future PRs)

  • Operator implementation patterns (controller-runtime, webhooks, finalizers, etc.)
  • Development workflows and practices (testing, API evolution, enhancement process)
  • Evaluation framework (promptfoo config)

Review Focus

  • Navigation: Does AGENTS.md provide clear task-based entry points?
  • Accuracy: Do domain docs match current OpenShift/Kubernetes APIs?
  • Completeness: Are the foundational concepts covered adequately?

Related

🤖 Generated with Claude Code

richardsonnick and others added 30 commits November 19, 2025 16:59
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Probably unnecessary complexity
Neilhamza and others added 28 commits May 10, 2026 11:02
Reword user story openshift#2 to align with non-goal openshift#4 (no reducing below
minimums). Add operational note about OOM kills and CPU throttling
when limits are configured.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ration

USHIFT-6913: Add DNS resource configuration enhancement for MicroShift
- Call out CEL immutability rule change as deliberate validation loosening
- Clarify UseSharedIngressHCP/HC naming distinct from isAroHCP() in main.go
- Add envtests for CEL rule validation to integration test plan

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…gy-api-driven

OCPSTRAT-1986: Enhancement: API-driven Azure topology and Swift private connectivity for HyperShift
…er-update

CNTRLPLANE-2121: doc running pre-flight checker on every configuration change
CNTRLPLANE-2711: extend kms encryption enhancement with vault KMS plugin api
…m PKI

Signed-off-by: Bharath B <bhb@redhat.com>
NO-JIRA: Clarify the secretref datakey structure reason
…licy

ESO:418 updated the enhancement proposal to include the network policy for proxy
USHIFT-6790: MicroShift Cluster 2 Cluster Communication
Add enhancement spec for api tls curves
ESO-417: Extends ExternalSecretsConfig with trustedCABundle for custom PKI
…ption

OCPSTRAT-2527, OCPSTRAT-2540: Enhancement: etcd data re-encryption for key rotation in HyperShift
Introduce ai-docs/ directory with foundational navigation and core
platform concepts to enable AI-assisted development workflows.

Foundation (Navigation & Principles):
- AGENTS.md: Navigation index with task-based flows
- CLAUDE.md: Symlink for AI agent compatibility
- ai-docs/DESIGN_PHILOSOPHY.md: Core principles and patterns
- ai-docs/KNOWLEDGE_GRAPH.md: Visual concept map
- ai-docs/references/: Glossary and reference index

Domain Knowledge (Platform Concepts):
- ai-docs/domain/kubernetes/: Pod, Service, CRD patterns
- ai-docs/domain/openshift/: ClusterOperator, ClusterVersion APIs
- ai-docs/platform/operator-patterns/status-conditions.md: Condition patterns
- ai-docs/platform/openshift-specifics/upgrade-strategies.md: Upgrade safety

Workflows:
- ai-docs/workflows/topology-considerations-guide.md: SNO, MicroShift, Hypershift

This establishes the framework for subsequent operator patterns,
workflows, and practices documentation.

Related: openshift#1992
@Prashanth684 Prashanth684 force-pushed the agentic-docs-foundation-domain branch from 7ed79db to 74935e5 Compare May 27, 2026 19:59
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.