Skip to content

Commit bbb32c3

Browse files
committed
Refactor agentic-docs plugin: remove platform-docs skill
Platform documentation in openshift/enhancements/ai-docs/ already exists and was created using this skill. Remove the /platform-docs skill that was designed to create it from scratch - it's no longer needed. Changes: - Remove entire skills/platform/ directory - Keep /update-platform-docs for incremental updates to existing platform docs - Keep /component-docs for creating component-level documentation - Update README to clarify platform docs "already exist" - Simplify tier architecture description (tier-1/tier-2 → platform/component) - Update component skill templates to reference "platform docs" consistently - Update validation scripts to remove platform-specific checks - Remove platform-docs from marketplace registration This simplifies the plugin to focus on its two active use cases: 1. Creating new component documentation (/component-docs) 2. Updating existing platform documentation (/update-platform-docs)
1 parent 198f3c2 commit bbb32c3

34 files changed

Lines changed: 470 additions & 1862 deletions

docs/data.json

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1831,15 +1831,10 @@
18311831
"name": "agentic-docs",
18321832
"skills": [
18331833
{
1834-
"description": "Create lean tier-2 component documentation for OpenShift repositories",
1835-
"id": "component",
1834+
"description": "Create lean component documentation for OpenShift repositories",
1835+
"id": "component-docs",
18361836
"name": "component-docs"
18371837
},
1838-
{
1839-
"description": "Create AI-optimized platform documentation for openshift/enhancements",
1840-
"id": "platform",
1841-
"name": "platform-docs"
1842-
},
18431838
{
18441839
"description": "Update existing platform documentation with automatic gap detection in openshift/enhancements",
18451840
"id": "update-platform-docs",
@@ -1849,4 +1844,4 @@
18491844
"version": "1.0.0"
18501845
}
18511846
]
1852-
}
1847+
}

plugins/agentic-docs/OWNERS

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
approvers:
2+
- Prashanth684
3+
- kenjpais
4+
- jatinsu
5+
- andymcc
6+
reviewers:
7+
- Prashanth684
8+
- kenjpais
9+
- jatinsu
10+
- andymcc

plugins/agentic-docs/README.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,46 +4,36 @@ AI-optimized OpenShift documentation with progressive disclosure, reference styl
44

55
## Two-Tier Architecture
66

7-
**Tier 1: Platform Hub** (`openshift/enhancements/ai-docs/`)
7+
**Platform Docs** (`openshift/enhancements/ai-docs/`) - **Already exists**
88
Generic patterns, testing, security, K8s/OpenShift fundamentals, cross-repo ADRs. ~34 files, 4.4k lines.
99

10-
**Tier 2: Component Repos** (`{component}/ai-docs/`)
11-
Component CRDs, architecture, local ADRs, exec-plans. Links to Tier 1. ~15 files, 2.5k lines (58% leaner).
10+
**Component Docs** (`{component}/ai-docs/`)
11+
Component CRDs, architecture, local ADRs, exec-plans. Links to platform docs. ~15 files, 2.5k lines (58% leaner).
1212

1313
## Skills
1414

15-
### `/platform-docs`
16-
Creates Tier 1 platform documentation in `openshift/enhancements/ai-docs/`.
17-
18-
```bash
19-
cd /path/to/openshift/enhancements
20-
/platform-docs
21-
```
22-
23-
Creates AGENTS.md (navigation) + ai-docs/ with: platform patterns (controller-runtime, webhooks, finalizers, RBAC, must-gather), domain concepts (K8s/OpenShift APIs), practices (testing, security, reliability), cross-repo ADRs, workflows (exec-plans, enhancement process), and references (repo-index, glossary, API pointers).
24-
2515
### `/update-platform-docs`
26-
Incrementally update Tier 1 docs with automatic gap detection.
16+
Incrementally update platform docs with automatic gap detection.
2717

2818
```bash
2919
cd /path/to/openshift/enhancements
3020
/update-platform-docs
3121
```
3222

33-
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 when ai-docs/ exists (otherwise use `/platform-docs`).
23+
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.
3424

3525
### `/component-docs`
36-
Creates Tier 2 lean docs in component repositories.
26+
Creates lean component docs in component repositories.
3727

3828
```bash
3929
cd /path/to/component-repository
4030
/component-docs
4131
```
4232

43-
Creates AGENTS.md + ai-docs/ with: component CRDs only, architecture, component ADRs, exec-plans, ecosystem links to Tier 1, development/testing guides. Excludes generic patterns (lives in Tier 1). Example: [machine-config-operator/ai-docs](https://github.com/openshift/machine-config-operator/tree/master/ai-docs).
33+
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).
4434

4535
## Development
4636

47-
Skills live under `skills/{platform,update-platform-docs,component}/` with SKILL.md, scripts, and templates.
37+
Skills live under `skills/{update-platform-docs,component-docs}/` with SKILL.md, scripts, and templates.
4838

4939
**License:** Apache 2.0

0 commit comments

Comments
 (0)