Zum Inhalt springen
Kitbay
Einreichen

documentation

MITAktualisiert am 11. Nov. 20265.616GitHub-Sterne

A writing guide for gh-aw's own documentation, which lives in the repository's docs folder and is built with Astro Starlight.

Was der Skill vermittelt

A writing guide for gh-aw's own documentation, which lives in the repository's docs folder and is built with Astro Starlight. It asks for short pages organised by the Diataxis framework, separating tutorials, how-to guides, reference and explanation, and describes the purpose and style of each type along with the Markdown conventions the site uses. It applies to contributors editing the gh-aw docs.

Funktionen

  • Write gh-aw docs pages by Diataxis type
  • Follow Starlight Markdown conventions
  • Keep tutorials, how-tos and reference separate