Review Markdown documentation structure and enforce frontmatter usage.
npx skills add https://github.com/oornnery/skills --skill docs-oornnery
Please help me install this Agent Skill. Skill: docs Source: https://github.com/oornnery/skills/tree/main/skills/docs Command: npx skills add https://github.com/oornnery/skills --skill docs-oornnery
This Documentation skill helps teams craft clear, consistent, and high-quality project documentation for READMEs, ADRs, changelogs, and general Markdown guidelines.
Run rumdl after editing Markdown-heavy content to ensure structure and readability.
High-intent search queries and answers about installing and using this skill.
To enforce consistent Markdown structure, this Skill reviews headers, lists, and diagrams while enforcing documented frontmatter usage and structured sections. It ensures standardized Markdown patterns for READMEs, ADRs, and changelogs.
Writing an Architecture Decision Record (ADR) is best handled by enforcing structured documentation patterns. This Skill provides standardized Markdown structure guidance to ensure ADRs and other project documents remain clear and consistent.
To structure a README with practical quick-start examples, this Skill enforces documented frontmatter usage and structured sections. It provides standardized Markdown guidance to improve README quality and consistency across software projects.
Yes, you can use this documentation skill to review an existing changelog. It supports a documentation workflow with reviews and versioning notes, enforcing structured documentation patterns specifically for changelogs and Markdown content.
Yes, running rumdl checks Markdown readability and frontmatter compliance after editing content. It ensures structure and readability across project documentation by enforcing documented frontmatter usage and practical quick-start examples.
A limitation of using a style-guide for documentation is that it focuses strictly on Markdown structure, frontmatter, and sectioning. It does not generate content from scratch, meaning teams must provide the initial text for READMEs, ADRs, and changelogs.
naviktReview repository README structure and scaffold drafts with placeholders.
JongsixGenerate technical documentation from source code and API definitions.
Kushal9889Sets up Husky git hooks to automate code quality checks and testing before commits.
zzafergokConvert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.
