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 new file mode 100644 index 000000000..6f2d86939 --- /dev/null +++ b/docs/help.md @@ -0,0 +1,20 @@ +--- +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. + +## 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 community](https://discord.gg/Enf6Z3qhVr). diff --git a/docs/roadmap.md b/docs/roadmap.md new file mode 100644 index 000000000..bff704dcd --- /dev/null +++ b/docs/roadmap.md @@ -0,0 +1,64 @@ +# 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 of that work. + +## Features + +High-level features we plan on implementing. + +- [ ] Command interface + * [ ] Command menu + * [ ] Fuzzy search +- [ ] Configuration (.toml based extensible configuration format) +- [x] Devtools + * [ ] Browser-inspired devtools interface with integrated DOM view, log, and REPL +- [ ] Reactive state +- [x] Themes + * [ ] Customize via config + * [ ] Builtin theme editor + +## 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 +- [ ] Color picker +- [x] Checkbox +- [ ] Content switcher +- [x] DataTable + * [x] Cell select + * [ ] Row / Column select + * [ ] API to update cells / rows + * [ ] Lazy loading API +- [ ] Date picker +- [ ] Drop-down menus +- [ ] 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 than Rich markdown, with scrollable code areas / collapseable sections) +- [ ] Plots + - [ ] bar chart + - [ ] line chart + - [ ] Candlestick chars +- [ ] Progress bars + * [ ] Style variants (solid, thin etc) +- [ ] Radio boxes +- [ ] Sparklines +- [ ] 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..d4d5e183a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,7 +6,7 @@ edit_uri: edit/css/docs/ nav: - Introduction: - "index.md" - - "getting_started.md" + - "getting_started.md" - "tutorial.md" - Guide: - "guide/index.md" @@ -23,6 +23,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 +117,8 @@ nav: - "reference/static.md" - "reference/timer.md" - "reference/widget.md" + - "help.md" + markdown_extensions: