Skip to content

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

Merged
dmartinol merged 7 commits into
RHEcosystemAppEng:mainfrom
dmartinol:review_docs
May 26, 2026
Merged

fix: Moved all doc files under the skill folder#92
dmartinol merged 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 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
Copy link
Copy Markdown
Contributor

@r2dedios r2dedios left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dmartinol Everything looks good to me! Just need to rebase the main branch before merging

@dmartinol
Copy link
Copy Markdown
Collaborator Author

dmartinol commented May 26, 2026

waiting for #106 to merge to fix ci issues

dmartinol added 7 commits May 26, 2026 13:17
…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>
…d clarity; add prerequisite and troubleshooting symlinks.

Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
@dmartinol
Copy link
Copy Markdown
Collaborator Author

@dmartinol Everything looks good to me! Just need to rebase the main branch before merging

rebased and reviewed the newly added skills to match the new layout, thanks!

@dmartinol
Copy link
Copy Markdown
Collaborator Author

/skill-code-review

1 similar comment
@r2dedios
Copy link
Copy Markdown
Contributor

/skill-code-review

Copy link
Copy Markdown
Contributor

@r2dedios r2dedios left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dmartinol dmartinol merged commit 27852c0 into RHEcosystemAppEng:main May 26, 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