gbdev / gbdev/pandocs

Registers formatting

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

Description

Feedback by @Bananattack on [Discord](https://discordapp.com/channels/303217943234215948/666927302348636160/673967141652791298):

> Hmm, I noticed the formatting for registers on the new pandocs is a funky right now:
>
> 1) It's currently inconsistent about whether a hardware register lists its hex address, a symbolic name, or its descriptive "full name". It should probably do all 3, in the order of "hex address - symbolic name - full name"
> 2) LCDC is missing its hex address, and is only called LCD Controller Register in the header.
> 3) Hexadecimal values should probably start with a $ to more clearly call out the numeric base.
> 4) The convention for indicating read/write of a register is inconsistent, sometimes it's (R/W), sometimes it's (Read/Write)

@endrift 's gbdoc (https://github.com/mgba-emu/gbdoc/blob/gh-pages/index.md#mmio) has a very nice way of documenting registers

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.