Closed exelotl closed 2 years ago
do we want to move the register descriptions into their respective pages?
I think this can be useful, I can't think of anything that doesn't fit in one category.
Is having short anchors such as #REG_DISPCNT important to us?
I think so, normally I send links to gbatek with the right anchor to the part I'm interested in showing. Maybe we can remove the extra information from the title of the section? Not sure how it would look like.
Note: CowBite packs a lot of info into its headings which leads to ugly anchors such as
#0x040000b0---reg_dma0sad-dma0-source-address-write-only
. Besides HTML, AsciiDoc is the only format I saw that provides a solution for this (letting you choose exactly what anchor a heading gets). Is having short anchors such as#REG_DISPCNT
important to us? Maybe the solution is just to come up with shorter headings.
Yes, I think we should have shorter titles (and anchors). Linking directly to a paragraph (e.g. a registry) is a basic feature I would expect from a documentation resource
Yes, I think we should have shorter titles (and anchors). Linking directly to a paragraph (e.g. a registry) is a basic feature I would expect from a documentation resource
Should it be possible for a title like "Display Control Register" to have an anchor like #dispcnt
(the actual name of the register), or would #display-control-register
suffice?
Yes, I think we should have shorter titles (and anchors). Linking directly to a paragraph (e.g. a registry) is a basic feature I would expect from a documentation resource
Should it be possible for a title like "Display Control Register" to have an anchor like
#dispcnt
(the actual name of the register), or would#display-control-register
suffice?
As long as it's not too long and with weird numbers and symbols, I think it's fine.
Yes, I think we should have shorter titles (and anchors). Linking directly to a paragraph (e.g. a registry) is a basic feature I would expect from a documentation resource
Should it be possible for a title like "Display Control Register" to have an anchor like
#dispcnt
(the actual name of the register), or would#display-control-register
suffice?
I think #display-control-register
is good enough. I'll start merging this and we can work on the anchors / h2/h3 names on another PR
This adds all the content from the original CowBite Spec.
We could probably fix this by switching to RSTSee note at bottom.<FONT>
) but it looks pretty decent for now. It could always be improved in the future.The following changes to the CowBite content have been made:
Next steps following this PR:
overview.md
(I removed it from the TOC for now, but it seems to have a mix of content fromintro.md
andmemory.md
)audio
content (I removed it from the TOC for now, it overlaps heavily with the audio stuff inregisters.md
)DISPCNT
goes in graphics,BGxOFS
goes in backgrounds, sound registers go into audio section?)Note: CowBite packs a lot of info into its headings which leads to ugly anchors such as
#0x040000b0---reg_dma0sad-dma0-source-address-write-only
. Besides HTML, AsciiDoc is the only format I saw that provides a solution for this (letting you choose exactly what anchor a heading gets). Is having short anchors such as#REG_DISPCNT
important to us? Maybe the solution is just to come up with shorter headings.