Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation style guidelines #14

Open
avivace opened this issue Feb 8, 2020 · 2 comments
Open

Documentation style guidelines #14

avivace opened this issue Feb 8, 2020 · 2 comments
Labels
awaiting feedback consistency - style Content format, text style, consistency in presenting the informations content Improvements or additions to documentation
Projects
Development Board
Milestone
v0.1.0

Comments

@avivace
Copy link
Sponsor Member

avivace commented Feb 8, 2020 •
edited

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 avivace added content Improvements or additions to documentation consistency - style Content format, text style, consistency in presenting the informations labels Feb 8, 2020
@avivace avivace added this to the v0.1.0 milestone Sep 8, 2020
@ISSOtm
Copy link
Member

ISSOtm commented Jul 14, 2021

What's the status on this?

@avivace avivace added this to Triage in Development Board Jul 24, 2021
@avivace
Copy link
Sponsor Member Author

avivace commented Sep 15, 2021

What's the status on this?

WIP in the wiki

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
awaiting feedback consistency - style Content format, text style, consistency in presenting the informations content Improvements or additions to documentation
Projects
Development Board
Triage
Milestone
v0.1.0
Development

No branches or pull requests
2 participants
@avivace @ISSOtm