search

gbdev / pandocs

The single, most comprehensive Game Boy technical reference.
https://gbdev.io/pandocs/
Creative Commons Zero v1.0 Universal
585 stars 90 forks source link

Add Glossary #194

Open avivace opened 3 years ago

avivace commented 3 years ago

I think a preliminary section mentioning some jargon and commonly used acronyms (e.g. LSB, MSB) could be helpful. It could also introduce some of the standards and rules we adopt in the document, adding some clarifications (e.g. units, bases)

Please see further in the thread for particular sticking points.

ISSOtm commented 3 years ago

As per #287, "dots" is introduced twice.

brainard52 commented 3 years ago

@avivace requested that I make a new issue, but I'll just hijack this one.

I think a glossary with links to each section the terms appear in would be great. It could additionally include definitions that appear on mouse-over of the term when the main body of the document (maybe with a delay).

ISSOtm commented 3 years ago

I can try adding markup for that as part of #292.

brainard52 commented 3 years ago

I can try adding markup for that as part of #292.

Nice. If you have a plaintext release of pandoc, I can extract a list of words that aren’t typically in an english dictionary for you

ISSOtm commented 3 years ago

Does this Markdown render do the job?

brainard52 commented 3 years ago

That’s great. If this works, we might even be able to integrate the glossary generation into the build.

avivace commented 3 years ago

To add: "CGB mode"

ISSOtm commented 3 years ago

Markup possibilities: https://github.com/commonmark/commonmark-spec/wiki/Deployed-Extensions#abbreviation https://github.com/commonmark/commonmark-spec/wiki/Deployed-Extensions#definition-list

avivace commented 1 year ago

Needs to be added to the Glossary: https://github.com/gbdev/pandocs/pull/350#discussion_r979296228

avivace commented 6 months ago

Needs to be added to the Glossary: https://github.com/gbdev/pandocs/pull/534#pullrequestreview-1819981650