Skip to content

Enhancement: documentation #278

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
Theoreticallyhugo opened this issue Aug 19, 2024 · 4 comments
Open

Enhancement: documentation #278

Theoreticallyhugo opened this issue Aug 19, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@Theoreticallyhugo
Copy link
Collaborator

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 Theoreticallyhugo added the enhancement New feature or request label Aug 19, 2024
@ethancedwards8
Copy link
Member

Yes. I think it is much needed.

@Theoreticallyhugo
Copy link
Collaborator Author

aight, on it :D

@farheinheigt
Copy link

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

@Theoreticallyhugo
Copy link
Collaborator Author

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.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
enhancement New feature or request
Development

No branches or pull requests

3 participants