Immediate-Mode-UI / Immediate-Mode-UI/Nuklear
missing part of documentation
- Dominant language
- C
- Stars
- 11.4k
- Forks
- 686
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 3
Description
the nuklear.h file report this docs index:
```
/// ## Contents
...
/// 6. API section
/// 1. Context section
/// 2. Input section
/// 3. Drawing section
/// 4. Window section
/// 5. Layouting section
/// 6. Groups section
/// 7. Tree section
/// 8. Properties section
/// 7. License section
...
```
and the generated Nuklear/doc/index.html is the same,
but nuklear.h prototype between 6.7 and 6.8 list those sub-chapters too:
```
Tree
LIST VIEW
WIDGET
TEXT
BUTTON
CHECKBOX
RADIO BUTTON
SELECTABLE
SLIDER
PROGRESSBAR
COLOR PICKER
Properties
```
those sub-chapters are hard find if not studying the whole header.
Can you please fix the documentation?
Contributor guide
Research direction
Compare the contents index in nuklear.h with the generated Nuklear/doc/index.html and the section headings listed between Tree and Properties. Update both documentation indexes so the missing sub-chapters are discoverable, then verify that the entries and ordering match the header.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100