doc: update roadmap and contents for future documentation goals
All checks were successful
Zig Project Action / Lint, Spell-check and test zig project (push) Successful in 44s

This commit is contained in:
2025-02-20 11:49:30 +01:00
parent 96375e3b72
commit e4ff240839

View File

@@ -112,6 +112,19 @@ the primary use-case for myself to create this library in the first place.
- [x] multi line
- [x] min size (provide size to use which would be a minimal size - as if the actual size is smaller then the `Container` will scroll and otherwise the contents expand to the available space instead?)
- [ ] image support through kitty protocol
- [ ] Examples
- [ ] scrollable content (i.e. show long text of an except of something and other smaller `Container`)
- [ ] min size
- [ ] mouse scrolling aware of mouse position
- [ ] layout options with different ways to create specific layouts
- [ ] vertical
- [ ] horizontal
- [ ] grid
- [ ] mixed
- [ ] Elements
- [ ] User input handling
- [ ] Text Input field
- [ ] Button
Decorations should respect the layout and the viewport accordingly. This means
that scrollbars are always visible (except there is no need to have a scrollbar)
@@ -168,6 +181,18 @@ containers? Some input may happen for a specific container (i.e. when using
mouse input). How would I handle scrolling for outer and inner elements of
a container?
### Documentation
A wiki should be created containing a bright overview of the structure and usage
of the library. For details it should refer to the examples. The documentation
should be minimal in terms of updateability in case the library changes. Maybe
some documentation could be derived from the code documentation (there is a tool
for this if I recall correctly).
Afterwards this README file contents can be updated to provide an actual
overview of the library in a short form containing links to the detailed
information required for usage.
### Archive
The alignment and sizing options only make sense if both are available. For