Skip to content

fix: Moved all doc files under the skill folder#92

Open
dmartinol wants to merge 7 commits into
RHEcosystemAppEng:mainfrom
dmartinol:review_docs
Open

fix: Moved all doc files under the skill folder#92
dmartinol wants to merge 7 commits into
RHEcosystemAppEng:mainfrom
dmartinol:review_docs

Conversation

@dmartinol
Copy link
Copy Markdown
Collaborator

@dmartinol dmartinol commented May 8, 2026

Summary

Moved all doc files under the skill folder. Rationale:

Exception to this rule: some pack-level metadata (AI index, source attributions) rather than skill docs are kept under <pack>/docs folders. We can review this decision later in another PR.

Added validation script to:

  • Enforce skill-local doc links (docs/...) in CI.
  • Catch broken or unsafe doc references early, so skills stay portable and reliable.
  • Detect symlink chains.

Note:
Some linked files where actually missed, so now they appear as placeholder files with this frontmatter:

---
title: TODO
status: draft
---

We can fix them in another run (at least now we can easily identify them).

Pack(s) affected

  • All

Change type

  • Update existing skill / agent
  • Docs / README
  • CI / tooling

CLAUDE.md compliance

  • Document consultation: file is read with the Read tool, then declared to the user

Validation

  • make validate passes locally

dmartinol added 6 commits May 8, 2026 14:59
…lnerability and let lola install the docs

Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
@dmartinol dmartinol marked this pull request as ready for review May 8, 2026 15:18
@r2dedios r2dedios added the documentation Improvements or additions to documentation label May 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants