agentleFS
dbareagimenodbareagimeno/enu/.claude/skills/sync-web/SKILL.md

sync-web

Skill2 starsChanged 4 months agoApache-2.0View on GitHub

Sincroniza la web de documentación (web/referencia/) con docs/contracts/api.md, la fuente de verdad, guiado por el detector mecánico check-drift. Úsala cuando el job "Coherencia web ↔ api.md" de CI esté en rojo, o como paso final de cualquier sesión/hallazgo que añada o toque firmas de api.md (el bump de nu.version.api es la señal).

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    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. Very specific:

    No toca docs/contracts/api.md ni los contratos: la dirección espec→web es única.

    line 56
  2. Distinctive:

    No relaja el detector para "hacer pasar" una página: si un caso legítimo no parsea, se arregla el script explicando el caso en su cabecera, …

    line 57
  3. Very specific:

    No la afecta el plugin de limpieza de la web (remark-limpieza-interno): su jurisdicción son los contratos de docs/*.md, nunca referencia/.

    line 60

≈ “Common” is an estimate: at least 1 in 5 of the 372,429 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

Sincronizar la web con la espec

La web (web/src/content/docs/referencia/) es una presentación derivada de docs/contracts/api.md: orientada a tareas, con prosa pedagógica y ejemplos verificados. La deriva mecánica (firmas, marcadores ⏸/[W], inventario) la detecta un script determinista; esta skill es la parte editorial que el script no puede hacer: redactar y verificar.

Protocolo

  1. Corre el detector: node web/scripts/check-drift.mjs (o npm run check:drift desde web/). Cada discrepancia trae fichero:línea y qué dice cada lado. --inventario vuelca el índice derivado de api.md en JSON.
  2. Decide la dirección del arreglo. docs/contracts/api.md manda siempre (web/README.md lo declara). Si al mirar una discrepancia concluyes que la espec está mal, eso no se arregla editando la web ni la espec a la ligera: es un candidato a hallazgo → /hallazgo. Todo lo demás se arregla en la web.
  3. Aplica las correcciones respetando las convenciones de las páginas:
    • Las firmas viven en fences sin etiqueta (las etiquetadas lua/sh son ejemplos y el detector las ignora). Texto de la firma idéntico al de api.md, espacios aparte; los métodos de un handle van indentados bajo la función que lo devuelve (nu.task.every(ms, fn) -> Timer + Timer:stop()).
    • Marcadores ⏸/[W]: en el heading que nombra la función (## nu.fs.read ⏸ [W]`; un heading de módulo como `## `nu.json [W]` cubre sus funciones), o inline en la línea de la firma cuando el heading agrupa sin nombrar ("Manipulación", "Mensajes"). Un heading que nombra a X no contagia marcadores a los métodos listados debajo: estos los llevan inline.
    • Comentarios de cola con -- (el detector los recorta antes de comparar).
    • convenciones.md y cli.md no declaran API: el detector las excluye.
  4. Función o namespace nuevo en api.md: sección nueva en la página del namespace (o página nueva en referencia/ + entrada en el sidebar de web/astro.config.mjs), imitando el tono de las existentes: qué es, la fence de firma, prosa del porqué y un ejemplo.
  5. Verifica los ejemplos nuevos contra el binario real (la convención de web/README.md): go build -o enu ./cmd/enu && ./enu -e '...'. Recuerda que el chunk de nu -e corre en el estado principal: las funciones ⏸ van envueltas en nu.task.spawn(...). Un ejemplo que no puedas ejecutar (red, TTY) se marca como tal en la página, no se inventa su salida.
  6. Cierra en verde: el detector a cero y npm run build (Astro valida enlaces y frontmatter). El commit, en español, cita el disparador (S##/G##) que movió la API.

Qué NO hace esta skill

  • No toca docs/contracts/api.md ni los contratos: la dirección espec→web es única.
  • No relaja el detector para "hacer pasar" una página: si un caso legítimo no parsea, se arregla el script explicando el caso en su cabecera, nunca añadiendo una excepción silenciosa a la comparación.
  • No la afecta el plugin de limpieza de la web (remark-limpieza-interno): su jurisdicción son los contratos de docs/*.md, nunca referencia/. Además, docs/contracts/api.md ya no se publica como página wiki (/docs/api se retiró): la única presentación web de la API es /api, derivada de web/src/content/docs/referencia/. El flujo espec→web de esta skill no cambia. (El alta/baja de páginas de la wiki lo lleva /alta-wiki.)

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.