pandocs icon indicating copy to clipboard operation
pandocs copied to clipboard

Documentation style guidelines

Open avivace opened this issue 5 years ago • 2 comments

Some guidelines on the style we should adopt/apply suggested by @Bananattack :

  • use consistent formatting;
  • any new information / rewrites should be written clearer than the original;
  • keep things concise and short;
  • don't repeat information like register/mode descriptions, reference/backlink to existing information instead;
  • present things as clear rules/definitions first, then explain or elaborate after.

Related issues: #55

avivace avatar Feb 08 '20 16:02 avivace

What's the status on this?

ISSOtm avatar Jul 14 '21 21:07 ISSOtm

What's the status on this?

WIP in the wiki

avivace avatar Sep 15 '21 12:09 avivace