text

is documentation, is code, put it in your repo

linode docs

i use linode hosting because they have the best docs on the planet, i copy their docs style

https://www.linode.com/docs/

  • it is one repo so you can clone the entire thing and use it in vim and use it in the terminal
  • it is displayed well with copy to clipboard buttons and integrated with their site

gitlab docs

gitlab has a style guide

they are getting bloated and complicated but most of it is good advice, they need to back it up, good code becomes more simple not more complex, they make a good point "doc is code" which means it's in a git repo, this changed the game for docs

Comments