textual icon indicating copy to clipboard operation
textual copied to clipboard

[Docs] Review Events reference

Open rodrigogiraoserrao opened this issue 3 years ago • 2 comments

The Reference > Events pages don't look great at the moment.

rodrigogiraoserrao avatar Jan 31 '23 15:01 rodrigogiraoserrao

Guess this is stale. @rodrigogiraoserrao Any suggestions for more improvements? Feel free to close if not.

willmcgugan avatar Nov 22 '23 15:11 willmcgugan

This isn't stale, I was waiting for this to end up in TODO. The docs pages on events are too short to warrant a structure similar to the widgets reference. My suggestion is that we drop the sections that are written by hand or pulled directly from the API and instead just show the API.

E.g., the Key event would go from what's on the left to what's on the right.

Screenshot 2023-11-22 at 17 27 31

We could possibly leave just the initial sentence that describes the event in English.

rodrigogiraoserrao avatar Nov 22 '23 17:11 rodrigogiraoserrao

Pretty much handled by #4302.

davep avatar Mar 20 '24 15:03 davep

Don't forget to star the repository!

Follow @textualizeio for Textual updates.

github-actions[bot] avatar Mar 20 '24 15:03 github-actions[bot]