Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .claude-plugin/marketplace.json
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,12 @@
"source": "./plugins/marketplace-ops",
"description": "Maintenance commands for Claude Code plugin marketplaces",
"version": "0.1.2"
},
{
"name": "agentic-docs",
"source": "./plugins/agentic-docs",
"description": "Create and maintain AI-optimized documentation for OpenShift",
"version": "1.0.0"
}
]
}
20 changes: 20 additions & 0 deletions docs/data.json
Original file line number Diff line number Diff line change
Expand Up @@ -1822,6 +1822,26 @@
"name": "marketplace-ops",
"skills": [],
"version": "0.1.2"
},
{
"commands": [],
"description": "Create and maintain AI-optimized documentation for OpenShift",
"has_readme": true,
"hooks": [],
"name": "agentic-docs",
"skills": [
{
"description": "Create lean component documentation for OpenShift repositories",
"id": "component-docs",
"name": "component-docs"
},
{
"description": "Update existing platform documentation with automatic gap detection in openshift/enhancements",
"id": "update-platform-docs",
"name": "update-platform-docs"
}
],
"version": "1.0.0"
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
]
}
8 changes: 8 additions & 0 deletions plugins/agentic-docs/.claude-plugin/plugin.json
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"
}
}
10 changes: 10 additions & 0 deletions plugins/agentic-docs/OWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
approvers:
- Prashanth684
- kenjpais
- jatinsu
- andymcc
reviewers:
- Prashanth684
- kenjpais
- jatinsu
- andymcc
39 changes: 39 additions & 0 deletions plugins/agentic-docs/README.md
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
Loading
Loading