DOC: suggest and/or implement improvements to our documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 571
- Forks
- 50
- PR merge metrics
- No merged PRs in 30d
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?
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
Review the current Sphinx documentation at https://pdfly.readthedocs.io/en/latest/ and compare the proposed theme, extension, terminal-demo, and uvx quickstart ideas. Before starting, turn the discussion into a specific improvement with an agreed scope; done should mean the selected documentation changes are implemented and the published site is more useful and attractive.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100