AGENT SKILL

docs-portal

Discover and run the repository's documentation build and checks after docs-sync or edits to public documentation, navigation, or portal rendering.

License 许可
MIT
所属仓库
yasik/skills
最近更新
2026-11-08
Stars
★ 3
Forks
1

01 前言 Front Matter

name
docs-portal
description
Discover and run the repository's documentation build and checks after docs-sync or edits to public documentation, navigation, or portal rendering.

02 资源文件 1

03 SKILL.md 正文

Documentation portal

Keep content in its canonical source location. Discover public collections, internal exclusions, generated outputs, routes, and build commands from repository instructions and configuration. Do not assume a generator, path, or toolchain.

Workflow

  1. For changed prose, apply dev-docs. Reuse a completed docs-sync review when the text has not changed. If unavailable, report the missing review accurately.
  2. Inspect manifests, lockfiles, docs instructions, and CI to identify supported runtime versions and checks. Use the existing dependency installation command only when needed. Do not change package managers or upgrade dependencies.
  3. Run relevant configured documentation checks: formatting, links, anchors, examples, build, generated routes, or search coverage, as applicable. If no portal exists, run available source checks and report that no portal build applies; do not create a site just to execute this skill.
  4. Fix in-scope failures and repeat affected checks. For rendering or interaction changes, inspect a changed page at desktop and mobile sizes. Check affected navigation, search, code blocks, and themes supported by the site.
  5. Report source pages, exact checks, outcomes, and remaining gaps. Keep generated output out of version control unless the existing publishing process tracks it.

Preserve routes and links required by the actual renderer and repository readers. Exclude internal plans from public routes, navigation, and search. Do not maintain another content copy. A local rebuild does not publish the site; deployment needs existing authorization and follows the repository's release process.

04 同仓库更多 Skills

yasik
yasik/skills

terminal-report

Produce beautiful, structured terminal output for a CLI or analysis tool — ANSI colors, aligned data tables, inline bar charts, diverging/centered bars, tagged progress logs, sparklines, and section headers. Use this skill whenever you are building a command-line tool, analysis script, report generator, data dashboard, or status/progress display that prints to a terminal, OR whenever the user wants output to look "polished", "colored", "styled", "like a dashboard", or shows a screenshot of a pretty terminal and asks how to make one. Applies even when the user just says "print the results nicely" or "make a little CLI for this" without naming colors or charts explicitly.

★ 3
yasik
yasik/skills

technical-prose

Write and revise technical explanations, design docs, reviews, reports, and progress updates in clear, connected prose. Use when the reader needs to understand a mechanism or decision, or when a draft feels dense, choppy, jargon-heavy, or like compressed implementation notes. Preserve technical meaning while making the reasoning easy to follow.

★ 3
yasik
yasik/skills

teach

Teach a complex topic as one complete, self-paced written lesson — chaptered sections the learner reads top to bottom, a deep-dive that slows down on the single hardest concept and breaks it into steps with worked examples, diagrams only where they actually clarify, and real citations for going deeper. Works from an explicit topic ("teach me how Raft consensus works") or from one or more links/papers/docs the user wants to be brought up to speed on — it fetches them, falling back to a browser when a page is paywalled, JavaScript-rendered, or only partially retrievable. Use this whenever the user wants to *understand* something rather than just get an answer: "teach me X", "explain this <link>", "help me understand <topic>", "I want to learn <thing>", "break this down for me", "ELI5 but properly / but deep", or when they drop a URL and ask to be walked through it like a class. Distinct from a quick factual lookup or a terse summary — reach for this when the goal is durable understanding, not a TL;DR.

★ 3
yasik
yasik/skills

mermaid-render

Render a Mermaid diagram as a beautiful, optionally animated SVG (and PNG) in a calm editorial style, instead of stock Mermaid output. Supports flowchart, stateDiagram, and sequenceDiagram. Use whenever the user wants to render, draw, beautify, restyle, or "make nice" a Mermaid / flowchart / sequence / state diagram, add animated data-flow to a diagram, or turn a described process or architecture into a polished diagram for a doc, README, or slide. All styling — colors, fonts, shapes, borders, animation — is configurable in one theme file.

★ 3
yasik
yasik/skills

dev-docs

Write, rewrite, or review developer documentation to a complete, packaged technical-writing style guide: tone, grammar, punctuation, formatting, procedures, code samples, placeholders, UI text, linking, naming, and a word list of about 700 terms, plus an index of every rule. Use whenever the user asks for developer docs, technical docs, a README, API reference, quickstart, how-to, tutorial, concept page, release notes, docstrings or reference comments, or a docs style review, or wants docs that read like a major platform's documentation. Also use to check a draft against the style guide or to look up a term in the word list.

★ 3
yasik
yasik/skills

unit-test-coverage

Select, write, and review meaningful tests of public functions and interfaces. Use when adding behavior, fixing a regression, reviewing test quality, or diagnosing failing tests. Every test must protect a critical behavior or flow; never add tests only to increase coverage.

★ 3