tmux icon indicating copy to clipboard operation
tmux copied to clipboard

Enhancement: documentation

Open Theoreticallyhugo opened this issue 1 year ago • 4 comments

I would like to write documenation for all the optional flags that can be set for this plugin. i'm thinking of a docs directory with a markdown file for each individual feature, though possibly grouping things like the gpu features.

before putting in the effort to write all this however, i would like to know if that is something that would be merged if done well. please let me know and i'll get to work :D

Theoreticallyhugo avatar Aug 19 '24 08:08 Theoreticallyhugo

Yes. I think it is much needed.

ethancedwards8 avatar Aug 19 '24 13:08 ethancedwards8

aight, on it :D

Theoreticallyhugo avatar Aug 19 '24 15:08 Theoreticallyhugo

Yep ! and there’s an error on the Dracula website.

The Continuum options section is under Kubernetes. It would be helpful to clarify that it’s not a plugin, and that Continuum and Resurrect are required as dependencies

farheinheigt avatar Aug 19 '24 18:08 farheinheigt

i am still working on the documentation, which you can follow here: https://github.com/Theoreticallyhugo/dracula-tmux/tree/feature/docs/docs

a bunch of things are not done, or not included yet.

additionally, im planning on picking up #224. as a part of that i'd like to add colour customisation to more places, as well as putting the variables in a separate file, allowing for easily using fully custom colours. i will be adding these features over time, whilst documenting them too.

Theoreticallyhugo avatar Sep 21 '24 20:09 Theoreticallyhugo

dependencies may be an interesting project for the docs, but ill close this issue for now

Theoreticallyhugo avatar May 01 '25 17:05 Theoreticallyhugo