Agent skill

Docs Conventions

by Inebrio in Inebrio/Routerly

Where documentation lives in this repository, how a page is structured, and what a change owes the docs.

AGPL-3.0Auto-check passed

Install Docs Conventions

skills CLI
$ npx skills add Inebrio/Routerly --skill docs-conventions -a claude-code

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

GitHub CLI
$ gh skill install Inebrio/Routerly docs-conventions --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/Inebrio/Routerly.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs-conventions .claude/skills/docs-conventions && 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
docs-conventions
GitHub stars
101
Token cost
~624 tokens
SKILL.md length
329 words
Files
1
Skills in repo
17
Repo updated
First seen
Licence
AGPL-3.0

At a glance

Where documentation lives in this repository, how a page is structured, and what a change owes the docs.

  • Updating documentation
  • SKILL.md covers Page shape, What a change owes and How to write it
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Docs Conventions is an agent skill from Inebrio/Routerly. Where documentation lives in this repository, how a page is structured, and what a change owes the docs. Use when writing or updating documentation.

Its SKILL.md is about 620 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

The repository describes itself as: Self-hosted LLM gateway that routes requests across AI providers (OpenAI, Anthropic, Gemini, Mistral, Ollama) using intelligent multi-policy scoring — including an LLM-native… The licence is AGPL-3.0.

When your agent uses it

  • Updating documentation

Example prompts

  • “/docs-conventions”

What it can do on your machine

Read from SKILL.md and the folder at commit bcf58f1. 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

    No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown).

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

  • Network

    No URLs in SKILL.md.

    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

Docs Conventions loads about 624 tokens when it runs. Until then it costs about 41 tokens; SKILL.md has 329 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
~624

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 Inebrio/Routerly at commit bcf58f1, republished under its AGPL-3.0 licence (© Inebrio). 329 words, ~624 tokens.

Download SKILL.mdSave it as .claude/skills/docs-conventions/SKILL.md (or your agent's skills folder).
name
docs-conventions
description
Where documentation lives in this repository, how a page is structured, and what a change owes the docs. Use when writing or updating documentation.

Documentation conventions

Content is markdown under docs/. The site that renders it is Docusaurus in website/, with the navigation in website/sidebars.ts.

DirectoryCovers
docs/getting-started/Install and first run
docs/concepts/How the product thinks: routing, experiments, profiles
docs/service/Running and configuring the service
docs/api/The proxy endpoints and the management API
docs/cli/Every command and flag
docs/dashboard/Every page, one file per page
docs/guides/, docs/integrations/, docs/examples/Task and client oriented walkthroughs
docs/reference/Tables a reader looks things up in
docs/assets/Images. The only place a screenshot may live

Page shape

Every page opens with frontmatter:

markdown
---
title: Commands
sidebar_position: 2
---

A new page is added to website/sidebars.ts, or nobody will find it. Position it where a reader would expect it, not at the end.

What a change owes

A feature is documented on every surface it ships on. Service change means the API page, the CLI page and the dashboard page, all three, or the documentation now describes a product that does not exist.

For each surface:

  • API: method, path, request and response bodies with real field names, status codes, the permission required, and one runnable example.
  • CLI: the command with its real flags, one example invocation, the output the user will actually see, and the exit codes.
  • Dashboard: where the thing is, what it does, what the states mean.

How to write it

  • Verify against the code, never against the story or the blueprint. Those say what was intended; the code is what shipped.
  • Every command and payload in a page must be copy-pasteable and correct. Run it before you write it down.
  • Document what exists now. No "coming soon", no future tense, no placeholder page.
  • Update the pages a change invalidates. A stale page is worse than a missing one: it is believed.
  • Same voice as the pages around it. Short sentences, second person, present tense. English, no em dashes.
  • Screenshots only when the words cannot do it. They go in docs/assets/ and nowhere else, and they are regenerated when the interface changes.

© Inebrio, AGPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/docs-conventions of Inebrio/Routerly.

Open the folder on GitHubat commit bcf58f1

Compare with similar skills

Docs Conventions 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.

Docs Conventions compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Conventions this skillInebrio/Routerly101—~624Automated safety check: PassAGPL-3.0
Ecc Conventionsaffaan-m/ECC276k—~2.8kAutomated safety check: PassMIT
Live DashboardNousResearch/hermes-agent252k—~2.1kAutomated safety check: PassMIT
Openclaw Live Updateropenclaw/openclaw392k—~3.7kAutomated safety check: PassMIT
Live Dashboardnexu-io/open-design100k—~2.1kAutomated safety check: PassApache-2.0
Living Docs Governanceaffaan-m/ECC276k1 repos~2.1kAutomated safety check: PassMIT

Similar skills

  • Ecc Conventions

    affaan-m/ECC

    Development conventions and patterns for ECC. An agent skill from affaan-m/ECC.

    276k GitHub stars~2.8k tokensUpdated 4 days ago
    DevelopmentAuto-check passed
  • Live Dashboard

    NousResearch/hermes-agent

    Build self-updating dashboards from live sources. An agent skill from NousResearch/hermes-agent.

    252k GitHub stars~2.1k tokensUpdated today
    Auto-check passed
  • Openclaw Live Updater

    openclaw/openclaw

    Maintain the canonical live OpenClaw main checkout, macOS LaunchAgent-managed Gateway, local macOS app, exact-head main CI, and recurring full release validation.

    392k GitHub stars~3.7k tokensUpdated today
    DevOps & CloudAuto-check passed
  • Live Dashboard

    nexu-io/open-design

    Notion-style team dashboard rendered as a Live Artifact. An agent skill from nexu-io/open-design.

    100k GitHub stars~2.1k tokensUpdated today
    Productivity & AutomationAuto-check passed
  • Keep a long-lived project's documentation from rotting by assigning existing project docs clear constitution, map, status, and history roles, then wiring the active agent harness to those canonical…

    276k GitHub starsUsed in 1 repo~2.1k tokens
    DevelopmentAuto-check passed
  • Naming Conventions

    thedaviddias/Front-End-Checklist

    A skill your agent uses when reviewing stylesheets, component styles, and responsive behavior related to Use consistent CSS naming conventions.

    74k GitHub stars~481 tokensUpdated 3 days ago
    Frontend & DesignAuto-check passed

More from Inebrio/Routerly

All 17 skills in this repo
  • Feature Lifecycle

    Inebrio/Routerly

    Run a Tier 1 or Tier 2 feature end to end — feature level, story level, parallelism, integration, and retrospective.

    101 GitHub stars~3k tokensUpdated today
    Auto-check passed
  • Story Lifecycle

    Inebrio/Routerly

    Run one user story end to end in its own worktree, from claim to merge.

    101 GitHub stars~905 tokensUpdated today
    Auto-check passed
  • Test Conventions

    Inebrio/Routerly

    Where tests live in this repository, how to run them, and what a story owes in coverage.

    101 GitHub stars~467 tokensUpdated today
    Auto-check passed
  • Validation Protocol

    Inebrio/Routerly

    How to validate a story against its criteria and write the report, including what counts as evidence and what counts as blocking.

    101 GitHub stars~628 tokensUpdated today
    Auto-check passed
  • Analysis Format

    Inebrio/Routerly

    Shape of a feature analysis document (00-analysis.md). An agent skill from Inebrio/Routerly.

    101 GitHub stars~472 tokensUpdated today
    Auto-check passed
  • Blueprint Format

    Inebrio/Routerly

    Shape of a story blueprint, the technical plan an orchestrator executes.

    101 GitHub stars~581 tokensUpdated today
    Auto-check passed

Questions about Docs Conventions

What does Docs Conventions do?

Where documentation lives in this repository, how a page is structured, and what a change owes the docs. Docs Conventions is an agent skill from Inebrio/Routerly. Where documentation lives in this repository, how a page is structured, and what a change owes the docs.

When should I use Docs Conventions?

Docs Conventions fits situations like: updating documentation.

How do I install Docs Conventions in Claude Code?

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

How do I install Docs Conventions in Codex?

Run `npx skills add Inebrio/Routerly --skill docs-conventions -a codex`. Or copy the skill folder (.agents/skills/docs-conventions in Inebrio/Routerly) into .agents/skills/docs-conventions in your project. Codex loads it when a task matches its description.

Can I use Docs Conventions 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 Inebrio/Routerly --skill docs-conventions -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-conventions, .gemini/skills/docs-conventions, .github/skills/docs-conventions and .opencode/skills/docs-conventions in your project.

What does Docs Conventions need to run?

SKILL.md names no scripts, command-line tools or credentials: Docs Conventions is instructions for the agent only.

Does Docs Conventions 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 Docs Conventions 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 Docs Conventions use?

Docs Conventions is published under the AGPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs Conventions use?

About 624 tokens (SKILL.md is roughly 2.5k 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 Docs Conventions?

Skills that share tags, products or a category with Docs Conventions: Ecc Conventions (affaan-m/ECC, 276k stars), Live Dashboard (NousResearch/hermes-agent, 252k stars), Openclaw Live Updater (openclaw/openclaw, 392k stars) and Live Dashboard (nexu-io/open-design, 100k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Conventions?

Inebrio (a GitHub organization) maintains it in Inebrio/Routerly, which has 101 GitHub stars. The repository holds 17 skills in this directory. The repository was last updated on October 8, 2026.

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