Alternative docs theme experiment (with builtin dark mode)
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Review the linked preview and the ReadCraft-io/showcase-synching fork to understand the proposed Sphinx theme experiment. Compare it with the current documentation setup; the issue names no file, test, or acceptance criterion, so clarify whether a theme integration is wanted before defining what done means.
Written by the indexing model from the issue text.
Description
Hi,
I’ve been using Syncthing recently and spent some time browsing the documentation. I noticed the docs are still using an older Sphinx theme, which is, of course, completely fine and functional. But I have also noticed a few tickets asking for dark mode.
Recently, I have created a new Clarity theme for Sphinx. Out of curiosity, I made a small fork where I tried rendering the same documentation with the Clarity theme, just as a side experiment.
I’m not suggesting any change, but I thought I’d share the preview in case you find it interesting or useful to look at.
– new docs: https://showcase.readcraft.io/syncthing/ (version switching doesn't work because I have used only the latest version for this experiment)
– fork: https://github.com/ReadCraft-io/showcase-synching
I could send a PR. Or, if this isn’t something you want to consider, feel free to ignore this — I just wanted to share the experiment.
Thanks for creating Syncthing 🙏
- Dominant language
- Python
- Stars
- 327
- Forks
- 653
- PR merge metrics
- No merged PRs in 30d
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.
More from syncthing/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Dark theme Open
Difficulty 5/5 Over a week Newbie friendliness 30/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100