prompt-toolkit / prompt-toolkit/python-prompt-toolkit
Docs are lacking for TUI applications
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10.6k
- Forks
- 815
- PR merge metrics
- No merged PRs in 30d
Description
Basically I wanted to make a prompt but also make it fullscreen with some styling. Although there's a ton of amazing docs for making a prompt with autocomplete/styling/etc it's not full screen, and when you get to the TUI part of the docs there's not much info on how to make anything wiith it.
There's not much here other than how to make a vertical/horizontal split and some basic keybinds.
I think these docs should be vastly improved. Otherwise this is a great python library and I think a lot more TUI programs would be written with it if there were better docs for applications
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the full-screen applications documentation at pages/full_screen_apps.html, especially the linked section describing splits and key bindings. Review the existing TUI documentation and examples to identify the missing application-building guidance; done means the page gives substantially clearer coverage of creating and styling full-screen applications.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100