How do I install the Documentation skill?

Run npx skillmds@latest add tomevault-io/documentation-24 in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Documentation safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Documentation?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Documentation free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Documentation?

tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Documentation by tomevault-io — Agent Skill

Name: Documentation
Author: tomevault-io

Documentation

Documentation deep-dive for the poku website covering Docusaurus setup, language policy, feature-to-docs mapping, conventions, JSDoc, and the changelog. Use when editing or adding docs or mapping a feature to its page. Use when this capability is needed.

tomevault-io Updated Sep 17, 2026

File contents

Documentation conventions and where to look. Read the actual website/ tree and config to confirm details, since pages and versions change over time.

1. Framework & Config

Docusaurus 3.x at website/. For the exact version, read website/package.json
Config: website/docusaurus.config.ts. Sidebar: website/sidebars.ts (top-level items are manual, the docs/tutorials/examples categories are autogenerated from their directories)
Versioning: the current docs are the active version, older majors are kept but marked unmaintained. Read the versions block in website/docusaurus.config.ts and website/versions.json for the live set of versions and their labels

2. Language Policy

English is mandatory. Use i18n (website/i18n/) only on explicit user request

3. Documentation Structure

The docs live under website/docs/:

Root pages cover the homepage, philosophy, and the comparison with other runners
documentation/ is the API reference, organized by area: assertions, helper APIs (under helpers/), and the poku runner with its CLI options (under poku/)
tutorials/ holds guided walkthroughs and examples/ holds runnable examples

Read the website/docs/ tree to discover the current pages rather than relying on a fixed list here, since pages are added and reorganized.

4. Feature-to-Docs Mapping

There is a close (not strictly 1:1) mapping between helper APIs in src/modules/helpers/ and pages under website/docs/documentation/helpers/. Conventions to expect:

Most helpers have a matching page of the same name
Related helpers are sometimes grouped into a subdirectory (for example, process-related helpers)
A single source helper can be split across multiple pages, and a single page can cover more than one export
The config option types inform the poku/options/ pages
The public surface is whatever package.json exports define, not the internal file layout

To find the doc for a feature, read the helpers directory and the docs directory and match by responsibility, rather than trusting a fixed table.

5. Documentation Conventions

When reading or writing docs, follow these patterns:

Front matter: YAML with sidebar_position and tags
Page structure: function signature (> fn(params)) then Basic Usage then Advanced then FAQ
Components: reusable MDX components live in website/src/components/ (for example FAQ, and History to document when a feature became available or had breaking changes across versions). Docusaurus components like Tabs/TabItem are also available
Category organization: _category_.json files

6. Inline Documentation (JSDoc)

Type definitions live in src/@types/
Pattern: description plus an @default tag
These inform the documentation content

7. Changelog

CHANGELOG.md is auto-generated. NEVER edit it.

Source: wellwelwel/poku — distributed by TomeVault.

---name: documentation-24description: Documentation deep-dive for the poku website covering Docusaurus setup, language policy, feature-to-docs mapping, conventions, JSDoc, and the changelog. Use when editing or adding docs or mapping a feature to its page. Use when this capability is needed.---Documentation conventions and where to look. Read the actual `website/` tree and config to confirm details, since pages and versions change over time.### 1. Framework & Config- Docusaurus 3.x at `website/`. For the exact version, read `website/package.json`- Config: `website/docusaurus.config.ts`. Sidebar: `website/sidebars.ts` (top-level items are manual, the docs/tutorials/examples categories are autogenerated from their directories)- Versioning: the `current` docs are the active version, older majors are kept but marked unmaintained. Read the `versions` block in `website/docusaurus.config.ts` and `website/versions.json` for the live set of versions and their labels### 2. Language Policy- English is mandatory. Use i18n (`website/i18n/`) only on explicit user request### 3. Documentation StructureThe docs live under `website/docs/`:- Root pages cover the homepage, philosophy, and the comparison with other runners- `documentation/` is the API reference, organized by area: assertions, helper APIs (under `helpers/`), and the `poku` runner with its CLI options (under `poku/`)- `tutorials/` holds guided walkthroughs and `examples/` holds runnable examplesRead the `website/docs/` tree to discover the current pages rather than relying on a fixed list here, since pages are added and reorganized.### 4. Feature-to-Docs MappingThere is a close (not strictly 1:1) mapping between helper APIs in `src/modules/helpers/` and pages under `website/docs/documentation/helpers/`. Conventions to expect:- Most helpers have a matching page of the same name- Related helpers are sometimes grouped into a subdirectory (for example, process-related helpers)- A single source helper can be split across multiple pages, and a single page can cover more than one export- The config option types inform the `poku/options/` pages- The public surface is whatever `package.json` `exports` define, not the internal file layoutTo find the doc for a feature, read the helpers directory and the docs directory and match by responsibility, rather than trusting a fixed table.### 5. Documentation ConventionsWhen reading or writing docs, follow these patterns:- **Front matter**: YAML with `sidebar_position` and `tags`- **Page structure**: function signature (`> fn(params)`) then Basic Usage then Advanced then FAQ- **Components**: reusable MDX components live in `website/src/components/` (for example `FAQ`, and `History` to document when a feature became available or had breaking changes across versions). Docusaurus components like `Tabs`/`TabItem` are also available- **Category organization**: `_category_.json` files### 6. Inline Documentation (JSDoc)- Type definitions live in `src/@types/`- Pattern: description plus an `@default` tag- These inform the documentation content### 7. Changelog- `CHANGELOG.md` is auto-generated. NEVER edit it.---> Source: [wellwelwel/poku](https://github.com/wellwelwel/poku) — distributed by [TomeVault](https://tomevault.io).

Frequently asked questions