Improve AI agent readiness with comprehensive documentation#769
Open
gmcculloug wants to merge 1 commit intoRedHatInsights:masterfrom
Open
Improve AI agent readiness with comprehensive documentation#769gmcculloug wants to merge 1 commit intoRedHatInsights:masterfrom
gmcculloug wants to merge 1 commit intoRedHatInsights:masterfrom
Conversation
This PR establishes a layered documentation system for AI-assisted development: **Created:** - Domain-specific guideline files (docs/*-guidelines.md) for security, API contracts, database, testing, and integration - AGENTS.md: Agent onboarding doc with cross-cutting conventions and docs index - CLAUDE.md: Claude Code-specific layer with build commands and behavioral preferences - CONTRIBUTING.md: Contribution workflow guide for humans and agents - .coderabbit.yaml: CodeRabbit configuration pointing to guideline files **Enhanced:** - README.md: Improved structure, added documentation index, better organized https://redhat.atlassian.net/browse/RHCLOUD-46839
Contributor
Author
|
Bump @lpichler Is it possible to review before pto? Or assign to some who should review. |
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
1 participant
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.
This PR establishes a layered documentation system for AI-assisted development.
What Changed
New Files
Domain-specific guideline files (
docs/*-guidelines.md):security-guidelines.md— Permission format, role flags, privilege escalation prevention, CI security checksapi-contracts-guidelines.md— JSON schema contracts, field specifications, naming conventionsdatabase-guidelines.md— Role seeding, version bumping, KSL schema patterns, tenant isolationtesting-guidelines.md— CI validation pipeline, local testing commands, pre-PR checklistintegration-guidelines.md— Deployment pipeline, GitHub actions, ConfigMap generationAgent documentation:
AGENTS.md— Repository layout, cross-cutting conventions, common pitfalls, PR workflow (agent-agnostic)CLAUDE.md— Claude Code-specific commands and behavioral preferences (imports AGENTS.md)CONTRIBUTING.md— Contribution workflow guide for humans and agentsConfiguration:
.coderabbit.yaml— Points CodeRabbit to guideline files for automated code review enforcementModified Files
README.md— Enhanced structure, added documentation index, improved organizationWhy This Matters
This layered documentation system enables:
Documentation Structure
https://redhat.atlassian.net/browse/RHCLOUD-46839
🤖 Generated with Claude Code