docs: add agent readiness documentation#324
Merged
tahmidefaz merged 1 commit intoRedHatInsights:masterfrom Apr 16, 2026
Merged
Conversation
RHCLOUD-46732 Add CLAUDE.md, AGENTS.md, CONTRIBUTING.md, docs/ARCHITECTURE.md, docs/testing-guidelines.md, and docs/component-development-guidelines.md. Update README.md with documentation index table. All changes are additive — no existing content removed. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
Author
|
/recheck |
Contributor
Author
|
/retest |
Contributor
Author
|
Konflux This is a docs-only PR — no code, test, or config changes. PR #323 (which has code changes) passed the same Konflux e2e pipeline recently. The failure is likely a transient environment/infrastructure issue in the Konflux e2e test runner (Playwright + credentials + proxy setup). Reviewers: the Konflux e2e failure is not related to these documentation changes. All code-quality checks pass. |
Contributor
|
/retest |
tahmidefaz
approved these changes
Apr 16, 2026
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
3 participants
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
RHCLOUD-46732
CLAUDE.mdwith@AGENTS.mdimport and build/test/lint commands for Claude CodeAGENTS.mdwith project overview, tech stack, directory structure, federated module exports, key conventions (Jotai state, PatternFly 6, widget system, responsive grid, API layer), common pitfalls, and documentation indexCONTRIBUTING.mdwith setup instructions, development workflow, conventional commit format, and PR guidelinesdocs/ARCHITECTURE.mdwith system design (Chrome shell integration, federated modules, Jotai atoms, two dashboard modes, backend API integration, responsive grid, widget mapping pipeline, deployment)docs/testing-guidelines.mdwith Jest setup, required mocks (useChrome, Scalprum), Jotai test patterns, jsdom polyfills, API mocking, snapshot testing, and Playwright e2edocs/component-development-guidelines.mdwith directory conventions, PatternFly 6 usage, atom/hook patterns, widget ID format, widget mapping structure, permission filtering, template data types, API integration, and stylingREADME.mdwith a documentation index table linking to all new and existing docsAll changes are additive — no existing content was removed or modified (aside from the README documentation index update).
Test plan
🤖 Generated with Claude Code