From b92c77e2509f58977bbc244697d8f36640bb0d6a Mon Sep 17 00:00:00 2001 From: Will McGugan Date: Sun, 16 Oct 2022 13:36:23 +0100 Subject: [PATCH 1/6] roadmap page --- docs/help.md | 17 +++++++++++++++ docs/roadmap.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 4 ++++ 3 files changed, 76 insertions(+) create mode 100644 docs/help.md create mode 100644 docs/roadmap.md diff --git a/docs/help.md b/docs/help.md new file mode 100644 index 000000000..8453960f7 --- /dev/null +++ b/docs/help.md @@ -0,0 +1,17 @@ +# Help + +Here's where to go if you need help with Textual. + +## Bugs and feature requests + +Report bugs via GitHub on the Textual [issues](https://github.com/Textualize/textual/issues) page. + +You can also post feature requests via Github issues, but see the [roadmap](./roadmap.md) first. + +## Forum + +Visit the [Textual forum](https://community.textualize.io/) for Textual (and Rich) discussions. + +## Discord Server + +For more realtime feedback or chat, join our discord server to connect with the [Textual](https://discord.gg/Enf6Z3qhVr) community. diff --git a/docs/roadmap.md b/docs/roadmap.md new file mode 100644 index 000000000..16b91de7c --- /dev/null +++ b/docs/roadmap.md @@ -0,0 +1,55 @@ +# Roadmap + +We ([textualize.io](https://www.textualize.io/)) are actively building and maintaining Textual. + +We have many new features in the pipeline. This page will keep track that work. + +## Features + +- [ ] Command interface + * [ ] Command menu + * [ ] Fuzzy search +- [ ] Configuration (.toml based extensible configuration format) +- [x] Devtools + * [ ] Browser-inspired devtools interface with integrate DOM view, log, and REPL +- [ ] Reactive state +- [ ] Themes + +## Widgets + +Widgets are key to making user friendly interfaces. The builtin widgets should cover many common (and some uncommon) use-cases. The following is a list of the widgets we have built or are planning to build. + +- [x] Buttons + * [x] Error / warning variants +- [x] Checkbox +- [ ] Content switcher +- [x] DataTable + * [x] Cell select + * [ ] Row / Column select + * [ ] API to update cells / rows + * [ ] Lazy loading API +- [ ] Form Widget + * [ ] Serialization / Deserialization + * [ ] Export to `attrs` objects + * [ ] Export to `PyDantic` objects +- [ ] Image support + - [ ] Half block + - [ ] Braile + - [ ] Sixels, and other image extensions +- [x] Input + * [ ] Validation + * [ ] Error / warning states + * [ ] Template types: IP address, physical units (weight, volume), currency, credit card etc +- [ ] Markdown viewer (more dynamic that Rich markdown, with scrollable code areas / collapseable sections) +- [ ] Plots + - [ ] bar chart + - [ ] line chart + - [ ] Candlestick chars +- [ ] Progress bars + * [ ] Style variants (solid, thin etc) +- [ ] Tabs +- [ ] TextArea (multi-line input) + * [ ] Basic controls + * [ ] Syntax highlighting + * [ ] Indentation guides + * [ ] Smart features for various languages diff --git a/mkdocs.yml b/mkdocs.yml index 4c74f759a..036e425d3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,6 +7,7 @@ nav: - Introduction: - "index.md" - "getting_started.md" + - "help.md" - "tutorial.md" - Guide: - "guide/index.md" @@ -23,6 +24,7 @@ nav: - "guide/widgets.md" - "guide/animation.md" - "guide/screens.md" + - "roadmap.md" - How to: - "how-to/index.md" - "how-to/animation.md" @@ -116,6 +118,8 @@ nav: - "reference/static.md" - "reference/timer.md" - "reference/widget.md" + - "help.md" + markdown_extensions: From 15ab284d95b23cfe45b5408a183bc8753d95229e Mon Sep 17 00:00:00 2001 From: Will McGugan Date: Sun, 16 Oct 2022 13:47:28 +0100 Subject: [PATCH 2/6] help pages --- docs/getting_started.md | 4 ++++ docs/help.md | 11 +++++++---- mkdocs.yml | 3 +-- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/getting_started.md b/docs/getting_started.md index 9ddf67e9a..843297306 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -47,3 +47,7 @@ textual --help ``` See [devtools](guide/devtools.md) for more about the `textual` command. + +## Need help? + +See the [help](./help.md) page for how to get help with Textual, or to report bugs. diff --git a/docs/help.md b/docs/help.md index 8453960f7..9786d994e 100644 --- a/docs/help.md +++ b/docs/help.md @@ -1,12 +1,15 @@ +--- +hide: + - navigation +--- + # Help Here's where to go if you need help with Textual. ## Bugs and feature requests -Report bugs via GitHub on the Textual [issues](https://github.com/Textualize/textual/issues) page. - -You can also post feature requests via Github issues, but see the [roadmap](./roadmap.md) first. +Report bugs via GitHub on the Textual [issues](https://github.com/Textualize/textual/issues) page. You can also post feature requests via Github issues, but see the [roadmap](./roadmap.md) first. ## Forum @@ -14,4 +17,4 @@ Visit the [Textual forum](https://community.textualize.io/) for Textual (and Ric ## Discord Server -For more realtime feedback or chat, join our discord server to connect with the [Textual](https://discord.gg/Enf6Z3qhVr) community. +For more realtime feedback or chat, join our discord server to connect with the [Textual community](https://discord.gg/Enf6Z3qhVr). diff --git a/mkdocs.yml b/mkdocs.yml index 036e425d3..d4d5e183a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,8 +6,7 @@ edit_uri: edit/css/docs/ nav: - Introduction: - "index.md" - - "getting_started.md" - - "help.md" + - "getting_started.md" - "tutorial.md" - Guide: - "guide/index.md" From b8a60a6d1d6325e11ba1852defde3b048eac513d Mon Sep 17 00:00:00 2001 From: Will McGugan Date: Sun, 16 Oct 2022 13:51:36 +0100 Subject: [PATCH 3/6] widgets --- docs/roadmap.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/roadmap.md b/docs/roadmap.md index 16b91de7c..0c4804b7b 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -28,6 +28,7 @@ Widgets are key to making user friendly interfaces. The builtin widgets should c * [ ] Row / Column select * [ ] API to update cells / rows * [ ] Lazy loading API +- [ ] Drop-down menus - [ ] Form Widget * [ ] Serialization / Deserialization * [ ] Export to `attrs` objects @@ -47,6 +48,8 @@ Widgets are key to making user friendly interfaces. The builtin widgets should c - [ ] Candlestick chars - [ ] Progress bars * [ ] Style variants (solid, thin etc) +- [ ] Radio boxes +- [ ] Sparklines - [ ] Tabs - [ ] TextArea (multi-line input) * [ ] Basic controls From 0513926f80eb2fd14bbc0c52fcb29c26e0e7a86c Mon Sep 17 00:00:00 2001 From: Will McGugan Date: Sun, 16 Oct 2022 13:56:41 +0100 Subject: [PATCH 4/6] features doc --- docs/roadmap.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/roadmap.md b/docs/roadmap.md index 0c4804b7b..a11088d99 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -6,6 +6,8 @@ We have many new features in the pipeline. This page will keep track that work. ## Features +High-level features we plan on implementing. + - [ ] Command interface * [ ] Command menu * [ ] Fuzzy search @@ -13,7 +15,9 @@ We have many new features in the pipeline. This page will keep track that work. - [x] Devtools * [ ] Browser-inspired devtools interface with integrate DOM view, log, and REPL - [ ] Reactive state -- [ ] Themes +- [x] Themes + * [ ] Customize via config + * [ ] Builtin theme editor ## Widgets From 0c5ea8d50d20f9b7dc4cf76915dd9c3d3f0e3c3d Mon Sep 17 00:00:00 2001 From: Will McGugan Date: Mon, 17 Oct 2022 09:55:28 +0100 Subject: [PATCH 5/6] updates --- docs/roadmap.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/roadmap.md b/docs/roadmap.md index a11088d99..bff704dcd 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -2,7 +2,7 @@ We ([textualize.io](https://www.textualize.io/)) are actively building and maintaining Textual. -We have many new features in the pipeline. This page will keep track that work. +We have many new features in the pipeline. This page will keep track of that work. ## Features @@ -13,7 +13,7 @@ High-level features we plan on implementing. * [ ] Fuzzy search - [ ] Configuration (.toml based extensible configuration format) - [x] Devtools - * [ ] Browser-inspired devtools interface with integrate DOM view, log, and REPL + * [ ] Browser-inspired devtools interface with integrated DOM view, log, and REPL - [ ] Reactive state - [x] Themes * [ ] Customize via config @@ -25,6 +25,7 @@ Widgets are key to making user friendly interfaces. The builtin widgets should c - [x] Buttons * [x] Error / warning variants +- [ ] Color picker - [x] Checkbox - [ ] Content switcher - [x] DataTable @@ -32,6 +33,7 @@ Widgets are key to making user friendly interfaces. The builtin widgets should c * [ ] Row / Column select * [ ] API to update cells / rows * [ ] Lazy loading API +- [ ] Date picker - [ ] Drop-down menus - [ ] Form Widget * [ ] Serialization / Deserialization @@ -45,7 +47,7 @@ Widgets are key to making user friendly interfaces. The builtin widgets should c * [ ] Validation * [ ] Error / warning states * [ ] Template types: IP address, physical units (weight, volume), currency, credit card etc -- [ ] Markdown viewer (more dynamic that Rich markdown, with scrollable code areas / collapseable sections) +- [ ] Markdown viewer (more dynamic than Rich markdown, with scrollable code areas / collapseable sections) - [ ] Plots - [ ] bar chart - [ ] line chart From d11875db0995672863bfb427e155b2ec782cd593 Mon Sep 17 00:00:00 2001 From: Will McGugan Date: Mon, 17 Oct 2022 10:04:36 +0100 Subject: [PATCH 6/6] typo --- docs/help.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/help.md b/docs/help.md index 9786d994e..6f2d86939 100644 --- a/docs/help.md +++ b/docs/help.md @@ -9,7 +9,7 @@ Here's where to go if you need help with Textual. ## Bugs and feature requests -Report bugs via GitHub on the Textual [issues](https://github.com/Textualize/textual/issues) page. You can also post feature requests via Github issues, but see the [roadmap](./roadmap.md) first. +Report bugs via GitHub on the Textual [issues](https://github.com/Textualize/textual/issues) page. You can also post feature requests via GitHub issues, but see the [roadmap](./roadmap.md) first. ## Forum