Agent skill

Documentation Sync

by homarr-labs in homarr-labs/homarr

Write Homarr docs only when users need information to set up, use, or troubleshoot the app.

Apache-2.0Auto-check passed

Install Documentation Sync

skills CLI
$ npx skills add homarr-labs/homarr --skill documentation-sync -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install homarr-labs/homarr documentation-sync --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/homarr-labs/homarr.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/documentation-sync .claude/skills/documentation-sync && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
documentation-sync
GitHub stars
5k
Token cost
~1k tokens
SKILL.md length
425 words
Files
2
Skills in repo
4
Repo updated
First seen
Licence
Apache-2.0

At a glance

Write Homarr docs only when users need information to set up, use, or troubleshoot the app.

  • Works in 5 steps: Every passage adds information a user… → Keep names, defaults, paths,… → Update every affected page and remove… → …
  • SKILL.md covers Locate a needed update, Follow existing typed patterns and Completion criteria
  • Calls pnpm and rg

What it does

Documentation Sync is an agent skill from homarr-labs/homarr. Write Homarr docs only when users need information to set up, use, or troubleshoot the app. Skip routine, obvious, or self-explanatory changes.

Its SKILL.md is about 1k tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files (for example `agents/openai.yaml`).

The repository describes itself as: A modern and easy to use dashboard. 80+ integrations. 20K+ icons built in. Authentication out of the box. No YAML, drag and drop configuration. The licence is Apache-2.0.

Example prompts

  • “/documentation-sync”

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

  1. Every passage adds information a user needs and cannot reasonably infer from the interface. Remove obvious, repetitive, or unnecessary…
  2. Keep names, defaults, paths, screenshots, links, and prerequisites consistent with code.
  3. Update every affected page and remove superseded guidance.
  4. Run the narrowest useful docs validation. Use pnpm turbo build --filter=@homarr/docs when links, MDX, generated definitions, or navigation…
  5. Treat broken links and anchors as failures; run pnpm --filter @homarr/docs validate:links after the static build.

What it can do on your machine

Read from SKILL.md and the folder at commit 3f02da7. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • pnpm
    • rg

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use pnpm, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Documentation Sync loads about 1k tokens when it runs. Until then it costs about 41 tokens; SKILL.md has 425 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~41
When it runs · the whole SKILL.md, loaded when a task matches
~1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from homarr-labs/homarr at commit 3f02da7, republished under its Apache-2.0 licence (© homarr-labs). 425 words, ~1,023 tokens.

Download SKILL.mdSave it as .claude/skills/documentation-sync/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
documentation-sync
description
Write Homarr docs only when users need information to set up, use, or troubleshoot the app. Skip routine, obvious, or self-explanatory changes.

Documentation Sync

Apply the audience and scope rules in AGENTS.md first. Documentation exists only for information users need to set up, use, or troubleshoot Homarr. A code, UI, or API change alone does not warrant documentation; if a user does not need to know it, do not add it.

For hidden capabilities such as the advanced widget feature, explain discovery, activation, and non-obvious behavior. For visible standard controls such as Delete, omit narration of what the label already conveys. Use the shortest explanation that preserves necessary technical detail; remove redundant prose in the passage being edited.

When an update is warranted, inspect adjacent pages for structure and types, not as a verbosity target. The mappings below locate needed information; they do not require a page for every feature or code change.

Locate a needed update

These are destinations for warranted updates, not triggers to add documentation:

Code changeDocumentation target
New integrationapps/docs/docs/integrations/<slug>/index.mdx and index.ts
New widgetapps/docs/docs/widgets/<slug>/index.mdx and index.ts
Changed public or management APIapps/docs/docs/management/api/index.mdx
New or changed environment variableRelevant page under apps/docs/docs/advanced/ or installation docs
New or changed CLI commandapps/docs/docs/advanced/command-line/
Authentication/provider changeRelevant SSO or authentication page under apps/docs/docs/advanced/
UI or workflow changeRelevant getting-started, management, widget, or integration page
Cron-job behaviorapps/docs/docs/management/tasks.mdx
Permission behaviorapps/docs/docs/management/users.mdx and the affected feature page
Custom Widget or Workshop behaviorRelevant Custom Widget, Assistant, or Workshop documentation

If no existing row fits, search by the user-visible term and update the page where a user would look for the behavior:

bash
rg -n "<term>" apps/docs/docs apps/docs/src
Show full SKILL.md (176 more words)Show less

Follow existing typed patterns

For an integration:

  • Add or update apps/docs/docs/integrations/<slug>/index.ts with the local IntegrationDefinition pattern.
  • Add or update index.mdx with the established IntegrationHeader, IntegrationCapabilites, and IntegrationSecrets components as applicable.
  • Reuse metadata from @homarr/definitions when the docs app already exposes it.

For a widget:

  • Add or update apps/docs/docs/widgets/<slug>/index.ts with the local WidgetDefinition pattern.
  • Add or update index.mdx with the established WidgetHeader, WidgetConfig, and AddingWidget components as applicable.
  • Explain only non-obvious option semantics, integration prerequisites, permission constraints, or behavior that the interface does not make clear.

Completion criteria

  1. Every passage adds information a user needs and cannot reasonably infer from the interface. Remove obvious, repetitive, or unnecessary prose.
  2. Keep names, defaults, paths, screenshots, links, and prerequisites consistent with code.
  3. Update every affected page and remove superseded guidance.
  4. Run the narrowest useful docs validation. Use pnpm turbo build --filter=@homarr/docs when links, MDX, generated definitions, or navigation can fail; otherwise run the docs package formatter on touched files.
  5. Treat broken links and anchors as failures; run pnpm --filter @homarr/docs validate:links after the static build.

© homarr-labs, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file in .agents/skills/documentation-sync of homarr-labs/homarr.

  • SKILL.md
  • agents/openai.yaml

Open the folder on GitHubat commit 3f02da7

Compare with similar skills

Documentation Sync next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Documentation Sync compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Documentation Sync this skillhomarr-labs/homarr5k—~1kAutomated safety check: PassApache-2.0
Claude-Mem Cloud Syncthedotmack/claude-mem97k—~1kAutomated safety check: NotesApache-2.0
Agent Sync Coordinatorruvnet/ruflo74k2 repos~4kAutomated safety check: PassMIT
I18n Syncaffaan-m/ECC274k—~1.8kAutomated safety check: PassMIT
Agent Project Board Syncruvnet/ruflo74k2 repos~2.9kAutomated safety check: PassMIT
Fal Lip Syncnexu-io/open-design100k—~308Automated safety check: PassApache-2.0

Similar skills

  • Claude-Mem Cloud Sync

    thedotmack/claude-mem

    Checks claude-mem cloud sync status and guides you through connecting a cmem.ai Pro account without the sync token ever passing through the chat.

    97k GitHub stars~1k tokensUpdated today
    Agent WorkflowsAuto-check: notes
  • Agent skill for sync-coordinator - invoke with $agent-sync-coordinator

    74k GitHub starsUsed in 2 repos~4k tokens
    Auto-check passed
  • I18n Sync

    affaan-m/ECC

    Translate and synchronize application JSON locale files using source-key usage, project terminology, and focused validation.

    274k GitHub stars~1.8k tokensUpdated 2 days ago
    Frontend & DesignAuto-check passed
  • Agent skill for project-board-sync - invoke with $agent-project-board-sync

    74k GitHub starsUsed in 2 repos~2.9k tokens
    Auto-check passed
  • Fal Lip Sync

    nexu-io/open-design

    Create talking head videos and lip sync audio to video via fal.ai.

    100k GitHub stars~308 tokensUpdated today
    Media & CreativeAuto-check passed
  • gbrain Sync

    garrytan/gstack

    Re-indexes a repository into gbrain and refreshes the agent search guidance in CLAUDE.md, safe to run again whenever search results look stale.

    136k GitHub stars~15k tokensUpdated today
    Agent WorkflowsAuto-check: notes

More from homarr-labs/homarr

  • MCP Integration

    homarr-labs/homarr

    Expose Homarr tRPC procedures safely through MCP. An agent skill from homarr-labs/homarr.

    5k GitHub stars~1.1k tokensUpdated today
    Auto-check passed
  • Codebase Context

    homarr-labs/homarr

    Navigate Homarr's monorepo architecture and reuse shared packages.

    5k GitHub stars~659 tokensUpdated today
    Auto-check passed
  • Homarr Custom Widget

    homarr-labs/homarr

    Author, validate, preview, test, install, or configure API-backed Homarr Custom JSX v2 widgets.

    5k GitHub stars~1.1k tokensUpdated today
    Auto-check passed

Questions about Documentation Sync

What does Documentation Sync do?

Write Homarr docs only when users need information to set up, use, or troubleshoot the app. Documentation Sync is an agent skill from homarr-labs/homarr. Write Homarr docs only when users need information to set up, use, or troubleshoot the app.

How do I install Documentation Sync in Claude Code?

Run `npx skills add homarr-labs/homarr --skill documentation-sync -a claude-code`. Or copy the skill folder (.agents/skills/documentation-sync in homarr-labs/homarr) into .claude/skills/documentation-sync in your project. Claude Code loads it when a task matches its description.

How do I install Documentation Sync in Codex?

Run `npx skills add homarr-labs/homarr --skill documentation-sync -a codex`. Or copy the skill folder (.agents/skills/documentation-sync in homarr-labs/homarr) into .agents/skills/documentation-sync in your project. Codex loads it when a task matches its description.

Can I use Documentation Sync in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add homarr-labs/homarr --skill documentation-sync -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation-sync, .gemini/skills/documentation-sync, .github/skills/documentation-sync and .opencode/skills/documentation-sync in your project.

What does Documentation Sync need to run?

Going by SKILL.md and its folder, Documentation Sync needs the command-line tools its instructions call (pnpm and rg).

Does Documentation Sync access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Documentation Sync safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Documentation Sync use?

Documentation Sync is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Documentation Sync use?

About 1k tokens (SKILL.md is roughly 4.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Documentation Sync?

Skills that share tags, products or a category with Documentation Sync: Claude-Mem Cloud Sync (thedotmack/claude-mem, 97k stars), Agent Sync Coordinator (ruvnet/ruflo, 74k stars), I18n Sync (affaan-m/ECC, 274k stars) and Agent Project Board Sync (ruvnet/ruflo, 74k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Documentation Sync?

homarr-labs (a GitHub organization) maintains it in homarr-labs/homarr, which has 5,018 GitHub stars. The repository holds 4 skills in this directory. The repository was last updated on October 7, 2026.

Source: homarr-labs/homarr on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.