Generate standardized five-section READMEs for Gaia folders.
npx skills add https://github.com/metraton/gaia --skill readme-writing-metraton
Please help me install this Agent Skill. Skill: readme-writing Source: https://github.com/metraton/gaia/tree/main/skills/readme-writing Command: npx skills add https://github.com/metraton/gaia --skill readme-writing-metraton
READMEs for Gaia folders are often terse or inconsistent, making it hard for developers to understand activation, scope, and conventions. This Skill enforces a structured, comprehensive README template to guide contributors and onboard new team members.
Follow the 5-section template to write or update the folder README and include activation details.
High-intent search queries and answers about installing and using this skill.
To structure a README for a Gaia folder, use a standardized five-section template covering Intro narrative, When activated, What's here, Conventions, and See also links to ensure activation clarity.
Documentation drift occurs when folder contents change but the README remains outdated, reducing onboarding clarity for Gaia components, which validation processes and drift-aware documentation aim to prevent.
To write activation guidance for a Gaia folder, include an activation-first section explaining when and how the folder's contents are invoked at runtime or during setup within the standardized README template.
Yes, you can apply this README template to any Gaia folder including the repo root, config, agents, skills, hooks, commands, bin, tests, build, and templates folders to enforce consistent documentation across components.
The best way to enforce README consistency during CI checks is to validate the five-section template structure and frontmatter, ensuring standardized activation details and documentation quality across all Gaia folders.
Yes, the Gaia README template requires frontmatter validation to enforce documentation standards, prevent drift, and maintain consistent activation clarity across all Gaia folders during feature development and CI checks.
dobrinz123Create Claude Code plugin skills with standardized SKILL.md frontmatter and activation guidance.
troykellyAudit documentation drift across Swagger/OpenAPI, features docs, and codebase.
solatisSynchronize CLAUDE.md navigation indexes and README.md architecture docs across a repository.
Clay-HHKDetect scientific file types and generate markdown EDA reports with quality metrics.
