gbdev / gbdev/pandocs

Documentation style guidelines

Open
#14 2 comments 0 reactions 0 assignees View on GitHub
awaiting feedback consistency - style content
Dominant language
Markdown
Stars
783
Forks
134
Avg merge
6h 54m
Merged PRs (30d)
3

Description

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.