gbdev / gbdev/pandocs

Add Glossary

Open
#194 10 comments 0 reactions 0 assignees View on GitHub
content enhancement
Dominant language
Markdown
Stars
783
Forks
134
Avg merge
6h 54m
Merged PRs (30d)
3

Description

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.

Contributor guide

Open the contributing guide

Research direction

Read the issue thread for the particular sticking points before editing the document. Add a preliminary glossary section covering the requested jargon and acronyms, standards and rules, units, and bases; done means those clarifications are included clearly in the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.