-
Notifications
You must be signed in to change notification settings - Fork 45
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershacktoberfestup-for-grabs
Description
Currently our documentation is a bit austere:
https://pdfly.readthedocs.io/en/latest/
It's built using Sphinx
It's functional, but not really attractive.
How do you think we could improve it?
There are some first random ideas:
- adopt a more attractive Sphinx theme?
- consider adopting some Sphinx extensions: https://sphinx-extensions.readthedocs.io/en/latest/ (or consider switching to
mkdocsif Sphinx ecosystem is really too limited) - add GIFs or terminal emulators (like https://github.com/Kibibit/command-lime or https://github.com/luisbraganca/fake-terminal-website) to showcase what
pdflycan do? - add an example of usage with
uvx, on the homepage, in a "quickstart" section?
Do you have other ideas? 🙂
Would you like to implement some of them?
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershacktoberfestup-for-grabs