agentleFS
Sign inStart free
PrairieAster-AiPrairieAster-Ai/quality-butler/skills/wiki-publish/SKILL.md

wiki-publish

Skill0 starsChanged 4 months agoApache-2.0View on GitHub

Shared GitHub-Wiki publishing substrate: generic `<!--PREFIX:NAME-->` marker stamping and the wiki clone/guard/commit/push plumbing. The common layer beneath /code-readability (doc pages, `cr:` markers) and /code-health (dashboard, `ch:` markers) so neither reimplements it. Use when publishing or stamping wiki pages.

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    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. Distinctive:

    Don't put *content generation* here — that's code-readability / code-health.

    line 62
  2. Very specific:

    Don't overwrite a page that lacks the generated marker (use guard).

    line 63
  3. Distinctive:

    Don't assume HTTPS/PAT can push a wiki — it's SSH only.

    line 64

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “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

Wiki Publish Skill

The publishing substrate shared by the documentation producers. It owns how content reaches the GitHub Wiki and stays current — not what the content is. Producers generate pages + a facts JSON; this skill stamps and publishes them.

Separation of concerns

ConcernOwner
What to document — TSDoc → Reference pages, team pages, Page-Anatomycode-readability
What to measure — the CodeHealth roll-up + dashboard factscode-health
How it's stamped + pushed to the wiki (markers, SSH clone/commit/push, guard)wiki-publish (this)

The quality-butler agent composes all three in its "document" step: producers write pages + facts, then wiki-publish stamps and pushes them.

The marker convention

Hand-authored prose stays curated; only the facts are regenerated, inside <!--PREFIX:NAME-->…<!--/PREFIX:NAME--> regions. Each producer owns a prefix:

  • ch: — CodeHealth (badge, chart, pie, MI counts, hotspots…) — from /code-health
  • cr: — code-readability team pages (prereqs, scripts, env, stack)

A new producer just picks a prefix and emits a facts JSON; stamp.mjs is generic.

Scripts

  • stamp.mjs <facts.json> <prefix> <file.md>... — fill every <!--prefix:NAME--> region from the facts JSON. Block values (charts/tables/mermaid) are padded onto their own lines. Idempotent. (Generalizes the old stamp-codehealth.mjs and the team-page stamping.)
  • wiki-repo.mjs — git plumbing:
    • url <repo> → derive the git@…/<repo>.wiki.git SSH URL
    • clone <wiki-url> <dest> → clone the wiki
    • guard <marker> <page.md>... → fail if a page to be written lacks the marker (i.e. it's hand-authored — never clobber it)
    • push <wiki-dir> "<msg>" → add/commit/push (no-op if clean; clear SSH-auth error)

Publish protocol (what the butler / producers follow)

  1. wiki-repo.mjs url → clone the wiki to a scratch dir.
  2. Producers write/refresh their pages into it and emit a facts JSON.
  3. wiki-repo.mjs guard "<!-- generated by … -->" <pages> before overwriting any generated page — protects hand-authored pages.
  4. stamp.mjs <facts.json> <prefix> <pages> to fill the marker regions.
  5. (code-readability's linkify-wiki.mjs if wiring source links.)
  6. wiki-repo.mjs push <wiki-dir> "<message>".

Don'ts

  • Don't put content generation here — that's code-readability / code-health.
  • Don't overwrite a page that lacks the generated marker (use guard).
  • Don't assume HTTPS/PAT can push a wiki — it's SSH only.

Files

  • scripts/stamp.mjs — generic marker stamper
  • scripts/wiki-repo.mjs — url / clone / guard / push

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