-
Notifications
You must be signed in to change notification settings - Fork 266
Add agentic-docs plugin: platform (enhancements repo) and component documentation #437
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Prashanth684
wants to merge
3
commits into
openshift-eng:main
Choose a base branch
from
Prashanth684:agentic-docs-ep
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "name": "agentic-docs", | ||
| "description": "Create and maintain AI-optimized documentation for OpenShift", | ||
| "version": "1.0.0", | ||
| "author": { | ||
| "name": "github.com/openshift-eng" | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| approvers: | ||
| - Prashanth684 | ||
| - kenjpais | ||
| - jatinsu | ||
| - andymcc | ||
| reviewers: | ||
| - Prashanth684 | ||
| - kenjpais | ||
| - jatinsu | ||
| - andymcc |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Agentic Docs | ||
|
|
||
| AI-optimized OpenShift documentation with progressive disclosure, reference style (tables/checklists), and pointer-based navigation. | ||
|
|
||
| ## Two-Tier Architecture | ||
|
|
||
| **Platform Docs** (`openshift/enhancements/ai-docs/`) - **Already exists** | ||
| Generic patterns, testing, security, K8s/OpenShift fundamentals, cross-repo ADRs. ~34 files, 4.4k lines. | ||
|
|
||
| **Component Docs** (`{component}/ai-docs/`) | ||
| Component CRDs, architecture, local ADRs, exec-plans. Links to platform docs. ~15 files, 2.5k lines (58% leaner). | ||
|
|
||
| ## Skills | ||
|
|
||
| ### `/update-platform-docs` | ||
| Incrementally update platform docs with automatic gap detection. | ||
|
|
||
| ```bash | ||
| cd /path/to/openshift/enhancements | ||
| /update-platform-docs | ||
| ``` | ||
|
|
||
| Scans ai-docs/, reports missing files, lets you fill gaps or add custom content. Auto-updates indexes/navigation and validates conventions. Use for incremental changes to existing platform documentation. | ||
|
|
||
| ### `/component-docs` | ||
| Creates lean component docs in component repositories. | ||
|
|
||
| ```bash | ||
| cd /path/to/component-repository | ||
| /component-docs | ||
| ``` | ||
|
|
||
| Creates AGENTS.md + ai-docs/ with: component CRDs only, architecture, component ADRs, exec-plans, ecosystem links to platform docs, development/testing guides. Excludes generic patterns (lives in platform docs). Example: [machine-config-operator/ai-docs](https://github.com/openshift/machine-config-operator/tree/master/ai-docs). | ||
|
|
||
| ## Development | ||
|
|
||
| Skills live under `skills/{update-platform-docs,component-docs}/` with SKILL.md, scripts, and templates. | ||
|
|
||
| **License:** Apache 2.0 |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.