Mention more source examples, as discussed in discussion #4653, point 1.

Textualize / textual

The lean application framework for Python. Build sophisticated user interfaces with a simple Python API. Run your apps in the terminal and a web browser.

https://textual.textualize.io/

MIT License

24.07k stars 741 forks source link

Mention more source examples, as discussed in discussion #4653, point 1. #4673

Closed merriam closed 4 days ago

merriam commented 1 week ago

Please review the following checklist.

[n/a] Docstrings on all new or modified functions / classes
[X] Updated documentation
[n/a] Updated CHANGELOG.md (where appropriate)

This is a documentation only update.

This mentions more source examples in introductory documents, per discussion #4653, point 1. Specifically, it mentions that there are examples in examples/ and docs/examples across docs/getting_started.md, docs/guide/index.md, and docs/widget_gallery.md

willmcgugan commented 4 days ago

This may give the impression that the short examples for widgets are the best way to structure a larger app. Searching the docs is pretty much guaranteed to give better results than grepping these examples.

I'll add a note in getting started, but I think its best to leave the other edits. Thanks for your time on this.