Skip to content

Documentation style guidelines  #14

Open
@avivace

Description

@avivace

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    awaiting feedbackconsistency - styleContent format, text style, consistency in presenting the informationscontentImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions