Results for “readme”

Generates thorough project documentation by exploring the codebase, identifying the tech stack and deployment target, and writing a comprehensive README.md covering local development, architecture, and production deployment.

Generates comprehensive README.md documentation by exploring the codebase, identifying the tech stack and deployment target, and producing a detailed guide covering local development, architecture, and production deployment.

Synchronizes documentation, READMEs, release notes, and operating docs with current shipped behavior when they have drifted.

Discovers installed skills and generates a catalog in README, JSON, or HTML format, updating documentation and optionally committing changes.

Produces high-quality written knowledge artifacts such as READMEs, guides, API specs, tutorials, runbooks, and wikis, with audience-appropriate structure and accuracy.

Generates and maintains project documentation: Google-style docstrings, README, architecture docs, and ADRs, with a mandatory post-task review gate to keep docs current.

Provides a structured README template for documenting XDG config directories, dotfiles, and script folders, helping users remember the purpose and contents of their local configuration.

Audits documentation health by scanning for README, changelog, API docs, ADRs, runbooks, onboarding guides, and diagrams, scoring coverage against project maturity, and recommending sub-skills to fill gaps.

Audits top-level documentation against recent git history to detect drift, applies minimal edits, and opens a pull request.

Records architectural decisions and documentation to capture the context, constraints, and trade-offs behind codebase choices.

Refactors a Python script into a beginner-friendly project with clear comments and a complete markdown tutorial.

Writes documentation optimized for AI agent consumption, including SKILL.md, README, and API docs, using layered context hierarchies and RAG-friendly formatting.

Analyze existing code files to generate a project-specific coding standards document, with options for templates, README insertion, and inconsistency detection.

Build and review high-quality technical documentation, including agent instruction files and contributor-governance files, with support for audits, multilingual parity, and sub-agent orchestration.

Generates task-oriented technical documentation with progressive disclosure for READMEs, API docs, architecture docs, and security reports after reverse engineering, penetration testing, or CTF tasks.

Turn rough notes, workshop content, or prompt dumps into compliant, publish-ready SKILL.md files that pass validation and integrate with repo documentation.