agentleFS
Sign inStart free
conectlensconectlens/lenserfight/.agents/skills/docs-manager/SKILL.md

docs-manager

Skill18 starsChanged 6 months agoMITView on GitHub

Refactor stale documentation or add new pages under docs/en/** (and other active locales). Covers Diátaxis classification, VitePress sidebar updates in apps/docs/.vitepress/config.ts, and build validation. Use when the user asks to update, fix, refactor, or add documentation pages — even when they don't explicitly say "docs.

3 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

10 rules. 0 are common, 4 are distinctive, and 6 are very specific to this project.

  • 0

    Common

    Most of the 3 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 6

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When unsure: how-to if the reader *does* something.

    line 30
  2. Very specific:

    Always create/update the docs/en/ page first.

    line 36
  3. Very specific:

    After EN is correct, adapt to each other active locale present under docs/<lang>/.

    line 37
  4. Very specific:

    If a locale's page doesn't exist yet, mirror the structure and mark untranslated prose with <!-- TODO: translate -->.

    line 38
  5. Very specific:

    Write pages so both search engines and generative-AI answer engines can surface them: meaningful title/description frontmatter, clear H1, …

    line 42
  6. Distinctive:

    Update only what drifted. Keep the existing voice.

    line 48
  7. Distinctive:

    Write/update EN first, then adapt to other active locales.

    line 49
  8. Very specific:

    Update apps/docs/.vitepress/config.ts if a page was added or moved.

    line 50
  9. Very specific:

    Run pnpm nx build docs and fix broken links.

    line 51
  10. Distinctive:

    Don't expose internal services, private admin flows, or implementation internals.

    line 55

“Common” is measured: kept by at least 6 in 10 of the 3 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

docs-manager

Helps with documentation work in this repo.

Sources of truth

What to verifyWhere to look
Feature behaviorlibs/domains/*
Platform ruleslibs/platform/*
DB schema / RLSsupabase/migrations/*
CLI commands & flagsapps/cli/src/commands/*
Existing doc contentdocs/en/** (default) · other active locales (e.g. docs/tr/**)
Sidebar configapps/docs/.vitepress/config.ts

Diátaxis quick guide

TypeFolderFor
tutorialtutorials/Learning by doing
how-tohow-to/Reaching a goal
referencereference/Looking things up
explanationexplanation/Understanding concepts

When unsure: how-to if the reader does something; reference if they look up something.

Language flow (GRASP — Information Expert + Pure Fabrication)

/en/ is the default and the Information Expert for documentation content — the canonical source other locales are derived from. Write or update English first, then adapt to each other active locale (e.g. /tr/) as a downstream port. This keeps a single authoritative origin and prevents conflicting edits across languages (low coupling, high cohesion).

  • Always create/update the docs/en/** page first.
  • After EN is correct, adapt to each other active locale present under docs/<lang>/**.
  • If a locale's page doesn't exist yet, mirror the structure and mark untranslated prose with <!-- TODO: translate -->.

SEO & GEO

Write pages so both search engines and generative-AI answer engines can surface them: meaningful title/description frontmatter, clear H1, semantic headings, plain factual phrasing, and unambiguous entity names (product, command, API).

Suggested flow

  1. Find the gap — grep docs/en/ (and other active locale folders), check the sidebar.
  2. Compare doc against the source of truth listed above.
  3. Update only what drifted. Keep the existing voice.
  4. Write/update EN first, then adapt to other active locales.
  5. Update apps/docs/.vitepress/config.ts if a page was added or moved.
  6. Run pnpm nx build docs and fix broken links.

Notes

  • Don't expose internal services, private admin flows, or implementation internals.
  • CLI examples should match current lf signatures.
  • API examples should match current RPC/REST contracts.
  • references/REFERENCE.md holds optional starter templates per Diátaxis type — useful when starting from scratch, but existing pages already vary in shape, so match the neighbors' format rather than forcing the template.

Download now (ZIP)

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