From e4ff24083947aebab81dee12ad7f2637f19a4246 Mon Sep 17 00:00:00 2001 From: Yves Biener Date: Thu, 20 Feb 2025 11:49:30 +0100 Subject: [PATCH] doc: update roadmap and contents for future documentation goals --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index cee875f..6b52f7c 100644 --- a/README.md +++ b/README.md @@ -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