HowTo docs

short

  • organize your content in folders
  • add one or more files to a folder
  • don’t name your files README.md

long

docs-as-code approach (see also: Documentation As Code)

Handle your (developer) documentation like code.

  • checkout the branch gh-pages
  • add / modify content
  • push it into the repo
  • wait 1 or 2 minutes (workflow index, publish to pages)