glion-readme

Generate and audit Diataxis-compliant READMEs for glion packages.

6|Updated Jan 29, 2023
One-click install
npx skills add https://github.com/rethinkhealth/glion --skill glion-readme
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: glion-readme
Source: https://github.com/rethinkhealth/glion/tree/main/.agents/skills/glion-readme
Command: npx skills add https://github.com/rethinkhealth/glion --skill glion-readme

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing and auditing READMEs for glion packages is error-prone and time-consuming; this skill automates adherence to the project's documentation framework and ensures consistency across the monorepo.

Core Features & Use Cases

  • Enforces a Diataxis-compliant, reference-voiced README structure for standard package READMEs and lint-rule READMEs.
  • Audits existing READMEs to surface voice, structure, and metadata drift and suggests corrections aligned with tests and package configs.
  • Generates a ready-to-publish README skeleton populated with metadata pills and references to tests and package.json constraints.

Quick Start

Audit or generate a canonical, Diataxis-compliant README for a glion package with a publish-ready structure.

Frequently Asked Questions about glion-readme

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a README for a glion package that follows Diataxi framework standards?

To generate a Diataxi-compliant glion package README, use this skill to derive metadata from package.json and tests, outputting a reference-voiced skeleton with precise metadata pills and test-aligned examples.

How do I audit an existing package README for structure and metadata drift?

You can audit an existing package README by applying this skill to surface voice, structure, and metadata drift, receiving suggested corrections aligned with your test files and package.json configurations.

What is the best way to enforce ESLint-style metadata in lint-rule READMEs?

Enforcing ESLint-style metadata in lint-rule READMEs is done by applying this skill to generate standardized documentation that aligns metadata pills and references with project-specific lint configurations.

Can I automate README consistency across an entire monorepo?

Yes, you can automate monorepo README consistency by using this skill to apply a unified Diataxi reference voice and derive standardized metadata across multiple package configurations and test files.

Do I need specific project files to generate a standards-compliant README skeleton?

You need project files like package.json and tests to generate a standards-compliant README skeleton, as the skill derives metadata pills and versioning constraints directly from these configurations.