Define documentation conventions for CLAUDE.md, README.md, and diff formats.
npx skills add https://github.com/riez/dots --skill conventions-docs
Please help me install this Agent Skill. Skill: conventions-docs Source: https://github.com/riez/dots/tree/main/.config/agentic/skills/conventions-docs Command: npx skills add https://github.com/riez/dots --skill conventions-docs
Documentation conventions unify how CLAUDE.md, README.md, and diffs are created, providing a single source of truth to reduce ambiguity and increase reproducibility.
Follow the conventions to locate the current guidelines for CLAUDE.md and README.md in the conventions repository.
High-intent search queries and answers about installing and using this skill.
To enforce documentation conventions, you can apply centralized guidelines for README and CLAUDE files. This provides a single source of truth with a YAML frontmatter template and a Markdown guide to standardize content creation.
Standardizing frontmatter schema involves applying a centralized YAML template for skill metadata like name and description. This ensures consistent metadata fields across documentation files and reduces ambiguity.
Writing implementation diffs requires following centralized diff format guidelines found in the conventions repository. These references provide clear usage examples to ensure your diffs match project standards during content creation.
No specific external tool is required to manage CLAUDE.md and README.md conventions. You can locate and apply current guidelines directly from the conventions repository to unify how your documentation is created.
Centralized guidelines for README and CLAUDE files reduce ambiguity and increase reproducibility across your project. They provide a single source of truth to unify how documentation and implementation diffs are created.
jwintzSanitize Obsidian vault frontmatter by fixing unescaped quotes and malformed YAML.
langadventurellcReview git diffs and issue data to plan documentation updates.
danburonlineFormat and edit Obsidian Markdown notes with wikilinks, embeds, callouts, and frontmatter.
hashicorpAutomates HashiCorp style-guide validation for Markdown documentation files.
