Expand description
Static data types used to represent all documentation entries.
Every entry is a 'static struct so the entire doc system lives in the
binary with zero heap allocation at startup.
Structs§
- Concept
Entry - Documentation for a language concept (variables, loops, types, etc.).
- Description
Entry - A single description with one or more accompanying rl code examples.
- FnEntry
- A single stdlib function’s documentation.
- StdEntry
- A stdlib module’s documentation, grouping related
FnEntrys together.
Enums§
- Concept
Category - Coarse grouping used to organize the concept index / nav.
- Description
Kind - What role a
DescriptionEntryplays, so the renderer can style it differently (e.g. a pitfall as a warning callout).