wiki-page-writer_skill

This skill generates comprehensive technical wiki pages with diagrams, citations, and first-principles explanations to document components or systems.

Go

3

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill linehaul-ai/linehaulai-claude-marketplace --skill wiki-page-writer

SKILL.md5.7 KB

Overview

This skill generates production-grade wiki pages and technical documentation with first-principles explanations, dark-mode Mermaid diagrams, and source-linked citations. It is designed for engineers and documentation owners who need traceable, implementation-first pages that can be dropped into a VitePress site. The outputs prioritize verifiable claims, structured tables, and multiple diagram types for clarity.

How this skill works

Before writing, the skill determines repository context (remote vs local) and default branch so every claim can be cited to exact file/lines. It analyzes the selected files and code paths, extracts functions/types/configs, and produces a VitePress-compatible Markdown page with frontmatter, multiple dark-mode Mermaid diagrams, citation-rich tables, and progressive disclosure from overview to implementation.

When to use it

Document a specific component, service, API, or subsystem with code-backed claims
Create a technical deep-dive or architecture page requiring multiple diagram types
Generate canonical wiki pages for onboarding, component catalogs, or design decisions
Produce VitePress-ready Markdown with frontmatter and dark-mode diagrams
Translate code structure into tables and pseudocode for cross-team reviews

Best practices

Always resolve repository context first (remote URL or local-only) so citations are exact
Scope pages by file count and audience; pick small/medium/large templates to meet diagram minimums
Cite every non-trivial claim to a file and line range; mark inferred claims explicitly
Use summary tables at the start of each section and include a Source column with links
Include 3–5 Mermaid diagrams using at least 2 diagram types and apply the dark-mode color rules

Example use cases

A backend engineer documents an authentication microservice with sequence and ER diagrams and line-cited handlers
A library maintainer generates a component catalogue page that lists public APIs, types, and source links
A team writes an implementation guide that traces data flow across repositories with flowcharts and class diagrams
Onboarding docs that map code paths to responsibilities and include pseudocode for reviewers

FAQ

I need to know if the repo has a remote URL (run git remote get-url origin) or is local-only, plus the default branch name so I can format citations correctly.

How many diagrams will you include?

I include 3–5 diagrams depending on scope and use at least two diagram types (e.g., graph + sequence + class) with dark-mode colors and autonumber for sequence diagrams.