gbdev / gbdev/pandocs

New custom container for "Sources" boxes

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

Description

See how the "upstream source" is reported in this articles:

- https://gbdev.io/pandocs/IR.html#gbc-infrared-communication
- https://gbdev.io/pandocs/Gameboy_Camera.html

I suggest preparing a new "custom container" to use in place of info boxes. Smaller font, maybe the highlight with a non-accent color (gray?).

We should also think about specifying (consistently) if the source should be considered the upstream against which contribute (e.g. Dan Docs you should contribute upstream, but the for the GB Camera document the author expressed the idea to just import it in Pan Docs and keep working on it there)

Contributor guide

Open the contributing guide

Research direction

Start by comparing the upstream-source sections in the linked IR and Game Boy Camera articles. Determine how a custom container would replace the current info boxes and how the upstream contribution guidance should be stated consistently. Done means the container styling and source guidance are defined for both cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.