Docs Rewrite

Open Rowlando13 opened this issue 11 months ago • 1 comments

The docs are good, but not great. Click is an awesome API so it should have really great docs.

Part I Big Swags

Take big swags at reorganization.
Rewrite sections to fit into Diataxis sections.
Include more examples.
Make the text more skimmable
Rewrite to make more concise and precise
Written to an person proficient in python, but not the command line.
Status: 100 percent.

Part II Nice for Long Term

Reorganize along diataxis sections and rewrite as necessary
- reference
- guides
- explanation
- tutorial
rewrite in myst if possible
note on landing page about type hints in docs
Not comprehensive, but the holes are obvious for future contributor work
Nice to have:
- fully type hinted
Status: 90 percent.

Part I PRs

#2515
#2551
#2580
#2585
#2586
#2821
#2825
#2838
#2848

Part II PRs

#2898
#2857
#2927
#2925
#2924

Jan 08 '25 07:01 Rowlando13

At some point I stopped adding PRs since there are so many. Type hinting will not be complete as part of this. The only thing remaining is converting to myst.

Sep 24 '25 17:09 Rowlando13