Introduce the 'custom containers' in the Foreword

Open Beginner friendly
#665 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
75/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
markdown
Domain
documentation

Research direction

Open the book's Foreword section and review how the custom containers are currently presented. Done means the Foreword includes a table describing TIP, WARNING, DANGER, and DETAILS, with an indication of their colors.

Written by the indexing model from the issue text.

Description

enhancement

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

Dominant language
Markdown
Stars
783
Forks
134
Avg merge
6h 54m
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from gbdev/pandocs

All issues in gbdev/pandocs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.