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.

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

Add Glossary #194

Open
avivace opened this issue Feb 23, 2021 · 10 comments
Open

Add Glossary #194

avivace opened this issue Feb 23, 2021 · 10 comments
Labels
content Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@avivace
Copy link
Sponsor Member

avivace commented Feb 23, 2021

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.

@avivace avivace added content Improvements or additions to documentation enhancement New feature or request labels Feb 23, 2021
@avivace avivace added this to the v0.1.0 milestone Mar 10, 2021
@ISSOtm
Copy link
Member

ISSOtm commented May 14, 2021

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

@brainard52
Copy link

brainard52 commented May 19, 2021

@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
Copy link
Member

ISSOtm commented May 19, 2021

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

@brainard52
Copy link

brainard52 commented May 19, 2021

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
Copy link
Member

ISSOtm commented May 19, 2021

Does this Markdown render do the job?

@brainard52
Copy link

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

@ISSOtm ISSOtm mentioned this issue May 24, 2021
@avivace
Copy link
Sponsor Member Author

avivace commented May 24, 2021

To add: "CGB mode"

@avivace
Copy link
Sponsor Member Author

avivace commented Nov 2, 2022

Needs to be added to the Glossary: #350 (comment)

@avivace
Copy link
Sponsor Member Author

avivace commented Jan 17, 2024

Needs to be added to the Glossary: #534 (review)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants