gbdev / gbdev/pandocs

Update theme/highlight.js with latest hardware.inc constants

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

Description

highlight.js hard-codes lists of RGBDS and hardware.inc symbols to be highlighted. Recent hardware.inc updates have added some symbols, and the planned 5.0 update (https://github.com/gbdev/hardware.inc/pull/58) would change many of them.

Note that none of hardware.inc's `B`/`F` bit number/flag constants are actually currently used anywhere in Pan Docs (`git grep -Pnw '[A-Z0-9]+[BF]_[A-Z0-9_]+'`), so none of the documentation itself needs updating.

Contributor guide

Open the contributing guide

Research direction

Start with theme/highlight.js and compare its hard-coded RGBDS and hardware.inc symbol lists with the planned hardware.inc 5.0 changes in pull request 58. Use the issue's git grep command to confirm that B/F bit and flag constants are not used in Pan Docs. Done means the highlighting lists reflect the updated symbols without requiring documentation changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.