agentleFS
Sign inStart free
web-infra-devweb-infra-dev/rstest/.agents/skills/rstack-docs-writer/SKILL.md

rstack-docs-writer

Skill514 starsChanged 8 days agoMITView on GitHub

Write or revise Markdown and MDX documentation, including READMEs, guides, and Rspress-based docs.

6 other projects use a version of this, 3 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use rstack-cli-docs.

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.
  • youzanSkill

    rstack-cli-docs

    Consult installed, version-matched Rstack docs only for user-facing `rs` command behavior, `rstack.config.*` semantics, or public `rstack` APIs. Do not use for purely internal implementation, tests, performance, or repository maintenance.

    Also in 5 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 4

    Common

    Most of the 3 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Common:

    Follow the project's existing documentation conventions.

    line 10
  2. Very specific:

    Keep common abbreviations such as dev server.

    line 15
  3. Common:

    Keep documentation in sync across locales when changing content.

    line 16
  4. Common:

    Prefer Rspress's default anchors for headings in the default locale.

    line 21
  5. Very specific:

    When anchors change, update corresponding IDs across locales and affected Markdown links and JSX href attributes.

    line 25
  6. Common:

    Check changed links against their target headings.

    line 26

“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

Rstack docs writer

Follow the project's existing documentation conventions.

Writing

  • Explain user-facing behavior concisely, adding details and examples only when they help users configure or use the feature.
  • Keep common abbreviations such as dev server.
  • Keep documentation in sync across locales when changing content. Use English as the default language unless the project specifies another.
  • Use sentence-case headings.

Heading anchors

  • Prefer Rspress's default anchors for headings in the default locale; preserve intentional existing custom IDs.
  • Determine generated anchors from heading id attributes: run the project's docs dev command and inspect the rendered browser DOM, or run its docs build command and inspect the generated HTML.
  • Match headings in other locales to the default locale's anchors, using the project's locale mapping to pair pages. Add custom IDs where defaults differ; remove redundant IDs only if anchors stay unchanged.
  • Escape custom IDs in MDX: ## Localized heading \{#default-locale-anchor}.
  • When anchors change, update corresponding IDs across locales and affected Markdown links and JSX href attributes. Check target pages before replacing hashes.
  • Check changed links against their target headings.

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