skills/smithery.ai/writeDocumentation

writeDocumentation

Installation
SKILL.md

Documentation du projet

Identifier le type de page

  • Utiliser ces chemins comme source de verite.
  • Choisir le format de page avant de rediger.
  • Toujours maintenir la doc dans les deux langues (FR et EN) et garder les sections synchronisees.

Chemins:

  • docs/{fr,en}/index.md: pages home.
  • docs/{fr,en}/v1/guide/*.md: guides.
  • docs/{fr,en}/v1/api/{namespace}/index.md: sommaire + presentation du namespace.
  • docs/{fr,en}/v1/api/{namespace}/{function}.md: documentation d'une fonction.
  • docs/{fr,en}/v1/api/{namespace}/{concept + function}.md: cas specifiques (rare).
  • docs/examples/v1/api/{namespace}/{function}/tryout.doc.ts: exemple simple.
  • docs/examples/v1/api/{namespace}/{function}/otherExample.doc.ts: cas specifiques.

Respecter les regles des exemples

Installs
1
First Seen
Apr 30, 2026