gbdev / gbdev/pandocs

Introduce the 'custom containers' in the Foreword

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

Description

The foreword should document the custom containers used throughout the book, so readers know what to expect when they encounter them.

A small table like :

| Container | Purpose (examples)|
|-----------|---------|
| `TIP` | Useful tips and best practices |
| `WARNING` | Important caveats or things to be careful about |
| `DANGER` | Critical warnings, e.g. about hardware damage or irreversible behavior |
| `DETAILS` | Collapsible supplementary information |

maybe previewing already the colors etc

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.