search

janoamaral / tokyo-night-tmux

A clean, dark Tmux theme that celebrates the lights of Downtown Tokyo at night.
https://github.com/janoamaral/tokyo-night-tmux/wiki
Other
251 stars 67 forks source link

Documentation Need's Fixing | Structural #50

Open AustinCGause opened 3 months ago

AustinCGause commented 3 months ago

When I initially began using this plugin, as someone with no experience with tmux, I found it very hard to understand the configuration options for this project and I found it hard to understand various small details. My suggestion would be to update this project with improved documentation so that it is easier for newcomers who love the tokyo-night theme like myself to get started with it.

janoamaral commented 3 months ago

It's true, it's rapidly growing and we need better documentation. There is a related issue (#10). I have to find time to make it right.

AustinCGause commented 3 months ago

I would love to help out with this issue. I would have no issue updating the structure and readability of the README.

janoamaral commented 3 months ago

I greatly value your help. I’ve recently established a wiki for this project, which I’m confident will enhance the documentation’s readability. The structure is organized as follows: the home page presents the general settings and an overview of the project. Each widget is detailed on its own page, complete with a dedicated configuration section. If a widget require particular dependencies, these will be documented as well. I'll make you collaborator so you can edit the pages.

AustinCGause commented 3 months ago

Thank you, I will begin with updating the README, given that it is "front and center", and then move onto the wiki when I feel that the README is sufficient.

Stealthii commented 2 months ago

The requirements section has been flattened into a list, with sections for OS specific instructions via https://github.com/janoamaral/tokyo-night-tmux/pull/63/commits/a91e24bb6b0de5a0a543ec1458d9c5cf3f6555e8, with heading and grammatical improvements in https://github.com/janoamaral/tokyo-night-tmux/pull/63/commits/ec66aa3d475f8cad866333e6038e8248263dac97, both part of #63.

This is not a complete overhaul to the documentation as it is out-of-scope for the PR, but should improve readability, especially the requirements in the meantime.