Run any Skill in Manus with one click

doc-methods

Stars17

Forks3

UpdatedJuly 24, 2026 at 01:23

The Sherpa documentation pipeline - md_to_docx with --style, LoF/LoT/LoW caption encoding, book indexes, RTL PDF generation, HAS/MAS vs operator guides. Use before generating or restructuring any deliverable doc.

Installation

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

Run Skill in Manus

Source

sean-galloway

sean-galloway/RTLDesignSherpa

View GitHub Repository View Creator Repositories

Download

Run Skill in Manus

Related occupationsSOC

Based on SOC occupation classification

Computer Hardware EngineersArchitecture and Engineering Occupations·SOC 17-2061

SKILL.md

readonly

name	doc-methods
description	The Sherpa documentation pipeline - md_to_docx with --style, LoF/LoT/LoW caption encoding, book indexes, RTL PDF generation, HAS/MAS vs operator guides. Use before generating or restructuring any deliverable doc.

doc-methods

READ FIRST: vault/handbook/INDEX.md (the handbook is the repo's memory; this skill is the signpost). Canonical pipeline how-to: bin/DOC_GENERATION.md. md_to_docx needs --style; LoF/LoT/LoW live in captions; no emojis in pipeline docs.

The handbook root is vault/handbook/INDEX.md - design/, dv/, fpga/ areas, atomic notes, wikilinked. When you learn a durable lesson in this domain, ADD IT TO THE HANDBOOK NOTE, not to this skill.

More from this repository

same repository

module-docs

sean-galloway/RTLDesignSherpa

Authoring a per-module reference page under docs/markdown (RTLCommon/RTLMath/RTLAmba) - the local .md style (header table, Overview, Architecture, Top-level Interface, Data model, Timing, Related, Test) and the SV header block that mirrors it. Use whenever you add or change an RTL block and need its docs/markdown page, and keep the book index in sync.

2026-07-2517

doc-placement

sean-galloway/RTLDesignSherpa

What kind of documentation lives where in this repo - handbook (method) vs docs/markdown (reader-facing) vs vault/Tasks (work) vs beside-code (CLAUDE.md, PRD). The rule that a beside-code README is a link, never a standalone guide, and that style guides / how-tos never live in the RTL tree. Use before creating, moving, or "tidying" any .md file, and when reviewing an area's meta-docs.

2026-07-2417

coverage

sean-galloway/RTLDesignSherpa

Coverage methodology - Verilator line/toggle coverage per component, functional coverage expectations, and the monbus packet-type coverage matrix. Use when adding tests, closing coverage, or preparing a board-gate sign-off.

2026-07-2417

filelists

sean-galloway/RTLDesignSherpa

Filelist rules - EVERY module MUST have a .f and MUST be registered in bin/filelists.toml. Components own their compile closure, consumers -f include, never hand-list another area's sources. Use when adding ANY new RTL module, test, or .f file.

2026-07-2417

formal

sean-galloway/RTLDesignSherpa

Formal verification flow - SymbiYosys via sv2v flatten, in-RTL ifdef FORMAL properties, mutation-checking every new assertion, harness vacuity traps. Use when writing properties, regenerating proofs, or after changing any module with a formal dir.

2026-07-2417

hard-design

sean-galloway/RTLDesignSherpa

HARD RTL design guidelines - reset macros, CDC, valid/ready contracts, streaming no-FSM pattern, SRAM rules, sizing invariants, signal-naming audit. Use when writing or reviewing any RTL.

2026-07-2417

Run any Skill with one click