agentleFS
Sign inStart free
wellwelwelwellwelwel/poku/.claude/skills/documentation/SKILL.md

documentation

Skill1.2k starsChanged 5 months agoMITView on GitHub

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.

We split this skill into the rules it gives an agent

3 rules. 0 are common, 2 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 94 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

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

    line 26
  2. Distinctive:

    When reading or writing docs, follow these patterns:

    line 42
  3. Distinctive:

    Punctuation: Use proper punctuation. Never use any kind of substitute as a crutch

    line 48

“Common” is measured: kept by at least 6 in 10 of the 94 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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
  • Punctuation: Use proper punctuation. Never use any kind of substitute as a crutch
  • Consistency: Match the writing style, tone, and structure of the related existing docs

6. Inline Documentation (JSDoc)

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

7. LLM Docs (Context7)

  • website/llms/ holds docs written for LLMs and indexed by Context7, separate from the human-facing pages in website/docs/
  • Current files: llms.md (the llms.txt entry point, symlinked to website/static/llms.txt), comparing.md, and philosophy.md
  • context7.json at the repo root controls what Context7 indexes and how it guides the agent through the folders allowlist (which includes website/llms), the description, and the rules
  • The description and rules have Context7 length limits, validated by test/unit/context7-rules.test.ts

8. Changelog

  • CHANGELOG.md is auto-generated: NEVER edit it!

Download now (ZIP)

Trending

Less talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 1 mentionMar 2026: 4 mentionsApr 2026: 7 mentionsMay 2026: 5 mentionsJun 2026: 4 mentionsJul 2026: 0 mentionsAug 2026: 0 mentionsSep 2026: 0 mentionsOct 2026: 1 mentionNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the wellwelwel/poku repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about wellwelwel/poku

The biggest 5 of 53 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 53

Talked about on GitHub, Bluesky and Hacker News (53 times).

On GitHub · 50

45 more on GitHub

On Hacker News · 1

  • Other versions103 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 103

    1. anthropics/knowledge-work-plugins★ 34ksame name
    2. comet-ml/opik★ 23ksame name
    3. mozilla-firefox/firefox★ 14ksame name
    4. microsoft/fast★ 9.7ksame name
    5. mufeedvh/code2prompt★ 7.7ksame name
    6. BrowserWorks/waterfox★ 6.4ksame name
    7. samchon/typia★ 5.9ksame name
    8. github/gh-aw★ 5.5ksame name
    9. epicenter-md/epicenter★ 4.8ksame name
    10. EpicenterHQ/epicenter★ 4.8ksame name

    93 more not listed

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • Used alongsideProjects with it also use project-preferences, response-style and 10 more.

    Other files people use alongside this one.

    Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
    • DepressionCenterSkill

      project-preferences

      Apply repository-specific preferences when planning, implementing, or reviewing changes in this project.

      Also in 4 projects that use this

    • DepressionCenterSkill

      response-style

      Write prose in plain, natural English. Apply to every response, design discussion, review comment, commit message, pull request, and document, in any task.

      Also in 4 projects that use this

    • BrowserWorksSkill

      accessibility-frontend-review

      Performs an accessibility code review of a local diff or Phabricator revision in the style of the Firefox accessibility team. Use this skill whenever the user asks to review a Phabricator patch or revision for accessibility issues, mentions a D-number (like D284142) in the context of accessibility review, asks "does this patch have any a11y issues", or wants to check a diff against accessibility guidelines. Also use it when the user says things like "can you review this for a11y", "check this patch", or "give me an accessibility review of D[number]". Invoke proactively when the user pastes a phabricator.services.mozilla.com URL or shares a revision ID alongside any accessibility concern. Invoke when questions about the following topics are raised: aria properties, aria roles, high contrast mode, forced colors, prefers contrast, focus order, screen readers, assistive technology.

      Also in 4 projects that use this

    • BrowserWorksSkill

      android-new-module

      Guide for creating new Android gradle modules in the android-components project.

      Also in 4 projects that use this

    • +8 more from BrowserWorks
  • In this repository8 other files it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free