documentation

Plugin documentation from marketplace ziogenetics in zio/zio-skills. Commands read from the repo's manifest — 17 days ago.

Skills (29)

• docs-add-missing-section

  Add a missing section to an existing data type reference page. Use when a required section (such as "Construction", "Predefined Instances", "Comparison", or "Advanced Usage") is entirely absent from an existing docs/reference/*.md file. The user provides the doc path and a description of what sectio

• docs-ascii-diagram

  How to produce an ASCII diagram that is actually aligned — generate it from a Python script with a width assertion, never by hand. Use when a page needs a box-and-arrow diagram, such as a module reference's "How They Work Together" section or a tutorial's data-flow picture.

• docs-backfill-metadata

  Fill in the missing `description` and `keywords` frontmatter fields on one documentation page, without touching anything else on it. Use when a page has no description or keywords for Docusaurus to index it with, or the user asks to "backfill metadata" or "add frontmatter".

• docs-check-compliance

  Audit a documentation file against a rule skill. Checks each rule, fixes violations with separate commits, then compiles with mdoc. Reusable across any rule skill and doc file.

• docs-companion-examples

  How to commission and verify a page's companion example files — the standalone runnable Scala a page pulls in with mdoc:embed or SourceFile.print. Use when a documentation page embeds example files rather than relying only on inline mdoc blocks, to delegate the build and check what came back.

• docs-cross-linker

  Make one or more existing ZIO documentation pages reachable by adding inbound prose links from pages that already discuss their subject. Use when a page is finished but nothing links to it, or the user asks to "cross-link", "make reachable", or "fix orphan pages".

• docs-data-type-list-members

  Use when extracting and categorizing public members from a Scala data type for documentation completeness checks.

• docs-data-type-ref

  Write a reference documentation page for a specific data type in a ZIO library. Use when the user asks to document a data type, write an API reference for a type, or create a reference page for a class/trait/object.

• docs-document-pr

  Decide, from a bare PR number, whether it needs a full new page, a subsection on an existing page, or nothing at all — then name the right skill for the job, writing nothing itself. Use when the user asks to document a PR and it is not already clear whether that means a new page or an addition to on

• docs-enrich-section

  Use when a documentation section exists but lacks motivation or use-cases — thin sections that show a signature and a toy example but never explain why a reader would choose this API over alternatives.

• docs-examples

  Shared rules for companion example files — where they live, which sections get one, the file template, shared code, the complete example, verification, formatting, and how a page embeds them. Used by docs-data-type-ref, docs-module-ref, docs-how-to-guide, docs-tutorial, and the docs-examples-builder

• docs-find-documentation-gaps

  Find and report undocumented areas of a ZIO library project that need documentation coverage in the docs directory. Generates a TODO-style report.

• docs-how-to-guide

  Write a how-to guide on a specific topic in a ZIO library. Use when the user asks to write a guide or walkthrough that teaches how to accomplish a concrete goal using the library's data types and APIs.

• docs-integrate

  Shared integration checklist for new ZIO library documentation pages. Include after writing any new reference page or how-to guide to ensure it is wired into the site navigation.

• docs-list-undocumented-prs

  Scans merged GitHub PRs (from latest commit back to an upstream base ref) and produces a documentation-coverage audit report. Processes 20 PRs per batch and asks before continuing to the next batch. Skips PRs already checked in previous runs using a persistent state file. For each new PR, determines

• docs-markdown-table

  How to produce a Markdown table that is aligned and structurally valid — generate it from a Python script with a cell-count and escaping check, never by hand. Use when a page compares things across three or more columns, such as a type roster, an edge-case table, or a variant comparison.

• docs-mdoc-conventions

  Shared reference for mdoc code block modifiers and Docusaurus admonitions used across ZIO library documentation skills. Include when writing any documentation that contains Scala code blocks.

• docs-module-ref

  Write reference documentation for a module containing multiple related data types. Use when documenting a cohesive domain model (HTTP model, resource management) where types work together. Produces comprehensive type-level pages plus module-level narrative showing relationships, patterns, and compos

• docs-organize-reference-docs

  Group an existing reference section into categories — propose the grouping from what the pages document, write each category's index page, and update sidebars.js without moving any file. Use when reorganizing an already-written reference section (any set of pages, not only single-type reference page

• docs-organize-types

  Organize related data types into logical categories within sidebars.js. Use this skill to group data types by functionality (e.g., "Collections", "Type System", "Resource Management", "DI & Configuration"). Supports manual categorization (specify types and category) or automatic analysis (scan docs/

• docs-pr-subsection

  Turn a GitHub pull request into one subsection appended to a page that already documents the area it touches — no new page, no sidebar edit. Use for a PR that only enhances or fixes something already documented, or when the docs-document-pr skill names this as the subsection case.

• docs-reduce-redundancy

  Remove redundant content from documentation. Use when sections repeat information unnecessarily, type definitions appear multiple times, concepts are introduced more than once, or transition words clutter meaning. Reduces cognitive load through deduplication and strategic cross-referencing.

• docs-report-method-coverage

  Use when checking if documentation covers all public members of a Scala data type.

• docs-research

  Shared research procedure for documentation agents and skills — find source, tests, examples, patterns, and GitHub history when researching a ZIO topic. Mounted by the docs-researcher agent and loaded directly by the docs-add-missing-section skill.

• docs-skill-retrospection

  Analyze a recent docs-* skill execution to close the feedback loop. Identifies deviations from documented workflow, unclear instructions, missing edge cases, and better approaches. Applies targeted improvements to the skill file based on what was learned. Run after any docs-* skill to capture retros

• docs-tutorial

  Write a tutorial for newcomers learning a topic in a ZIO library. Use when the user asks to write a tutorial or learning guide that teaches concepts step-by-step in a linear path. Tutorials are learning-oriented (for newcomers with no prior knowledge) unlike how-to guides which are task-oriented.

• docs-verify-compliance

  Fix compliance issues in a documentation file against writing style and mdoc conventions.

• docs-writing-style

  Prose style rules for documentation (reference pages, how-to guides, tutorials). Use this skill whenever writing or editing documentation to ensure consistency, clarity, and professionalism across all docs.

• setup-skill-hook

  Use this skill once to automatically install the ZIO skill attribution hook. After installation, all commits will automatically track which skills were used and include their versions.

Subagents (7)

• docs-designer

  Turns research findings into a validated plan for a ZIO documentation page.

• docs-drafter

  Writes a complete ZIO documentation page as Docusaurus markdown from a given plan and research findings.

• docs-examples-builder

  Creates, runs and verifies the companion example files for a documentation page (one per section that has code to run, plus a complete example on one-program pages). Use after the draft exists.

• docs-fixer

  Applies fixes docs-reviewer already composed: given a location and the exact corrected statement for it, edits the page to match — verbatim, no re-deriving, no rephrasing.

• docs-integrator

  Wires a new documentation page into the ZIO documentation site: sidebars.js, index.md, cross-references, and build verification. Use after mdoc passes.

• docs-researcher

  Researches a ZIO topic across source, tests, examples, and GitHub history; returns structured research answers in the shape the caller requests.

• docs-reviewer

  Evaluates a written ZIO documentation page two ways: a full-page check against a checklist and writing-style rules supplied in the task, or a fact-check of one section against the library source. Reports per-item pass/fail or per-drift findings, each with the exact corrected statement to apply.

Similar plugins