菜单
Write README.md files for hyperfrontend libraries and sub-modules. Use when creating library documentation, writing sub-module READMEs, documenting API tables, adding quick start guides, or reviewing README structure compliance.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | readme-docs |
| version | 1.0.0 |
| description | Write README.md files for hyperfrontend libraries and sub-modules. Use when creating library documentation, writing sub-module READMEs, documenting API tables, adding quick start guides, or reviewing README structure compliance. |
Create README.md files—library root for consumers, sub-module for maintainers.
| Item | Path |
|---|---|
| Library README | libs/<name>/README.md |
| Sub-module README | libs/<name>/src/<module>/README.md |
| Library ESLint | lib-readme-structure |
| Submodule ESLint | docs-site-secondary-entries |
| Submodule README | lib-pkg-secondary-entry-readme |
| Type | Location | Audience | Focus |
|---|---|---|---|
| Library README | libs/<name>/README.md | Consumers | Value prop, install, quick start |
| Sub-module README | libs/<name>/src/<mod>/README.md | Consumers | Intent, design, examples — NO API list |
The sub-module page renders this README plus an auto-generated scoped API reference. Manual API tables would duplicate the rendered ref.
Required sections (in order):
## What is @hyperfrontend/<name>?
### Key Features### Architecture Highlights## Why Use @hyperfrontend/<name>?## Installation## Quick Start## API Overview## CompatibilityRequired badges:
[](...)
[](...)
[](...)
[](...)
[](...)
[](...)
[](...)
[](...)
[](...)
Required links:
• 👉 See [**documentation**](https://www.hyperfrontend.dev/docs/libraries/<name>/)
• 👉 See [**roadmap**](https://github.com/AndrewRedican/hyperfrontend/blob/main/roadmap/<name>/)
Required (the floor):
# moduleName
One-sentence statement of what this module does and why it exists.
Optional sections — add when the module's complexity warrants them:
| Section | When to add |
|---|---|
## Overview | Multi-step pipelines, mermaid diagrams |
## Usage | Composition examples beyond a single signature |
## Configuration | User-facing config knobs that need explanation |
| Semantic tables | Taxonomies, decision rules, behavior contracts |
| Mermaid diagram | Data flow, state machines, dependency relations |
## Design | Trade-offs, invariants, "why this and not that" |
Do NOT include:
## API table listing exports (the page renders this automatically below your README).npx nx lint <project>
| Rule | Enforces |
|---|---|
lib-readme-structure | Library-root README sections, badges, links |
docs-site-secondary-entries | Every secondary entrypoint has a page.tsx + sidebar nav |
lib-pkg-secondary-entry-readme | Every secondary entrypoint has a README with H1 (matching basename) + description |
docs-site-library-docs | Every library README has a corresponding docs-site page |
Library README:
npx nx lint <project>Sub-module README:
Write conventional commits for the hyperfrontend monorepo — types, scopes (Nx project names), one-line subjects, atomic commits, versioning-harness boundaries. Use when committing, splitting work into commits, choosing a commit scope/type, or asked about commit format.
Register friction found while building hyperfrontend demos into the showcase findings registry. Use when a demo consuming @hyperfrontend/features surfaces an unclear API, confusing error, missing feature, docs gap, packaging snag, or DX papercut — file the finding before writing the workaround.
Write ARCHITECTURE.md files for hyperfrontend libraries. Use when creating architecture documentation, documenting design decisions, adding system overview diagrams, or explaining module composition and data flow.
Coding conventions for the hyperfrontend Nx monorepo. Use when refactoring, adding features, fixing bugs, or writing any new code across libs/, apps/, tools/, or plugins/.
Achieve 100% code coverage for custom ESLint rules. Use when reviewing ESLint rules for coverage gaps, adding missing tests, or applying istanbul ignore comments.
Create custom ESLint rules for the hyperfrontend Nx monorepo.