📖 HyDE.book

[0xGeN02]

💡 | Create a HyDE.book to simplify and clarify the way HyDE repo is intended to work

The following topics are an example of topìcs I consider key to facilitate users to comprehend everything about HyDE dotfiles.

◻️ How to set the Custom Configuration
◻️ How to Contribute to HyDE (explanation, standardization and guide of the contribution process)
◻️ Installation Guide (Done in Readme) -> Upgrade with Post-Instalation?
◻️ Keybidings (Done in Readme)
◻️ A brief review of all features of HyDE
◻️ System Requirements and Compatibility
◻️ Community and Resources
◻️ How to Create New RIcing/Features

I am asking to do something like this for a few reasons:

⁉️ Enhanced User Understanding and Adoption
⁉️ Streamlined Contribution Process
⁉️ Improved Project Maintainability
⁉️ Facilitated Knowledge Sharing

[dieBakterie]

What do you mean by HyDE.book exactly an book/user man/man pakge or what?

[0xGeN02]

As a newcomer to HyDE, I’ve found that as the project continues to expand, it becomes increasingly challenging to keep track of all the new features being implemented. To help new users get up to speed and easily deploy the functionality they need on their own machines, I suggest we develop a centralized resource similar to Foundry Book or ROS 2 Wiki. Such a guide would serve as a comprehensive, up-to-date reference, making it easier for users to explore and integrate the latest improvements in HyDE.

[0xGeN02]

Also something like a HyDE.toml.example with all the config options will be nice to have, instead of searching script by script on each config options that each feature has.

[0xGeN02]

@kRHYME7 if you think this is a good idea, this weekend in my spare time i can create a preview/alfa, so if you can give me any suggestions or ideas will be nice like how should i structure it and also the main features you want me to start

[kRHYME7]

https://github.com/HyDE-Project/hyde-site contribute here. I had a hard time outlining the stuff we should add.

• Getting started

•Installation and Updates

• Configuration should discuss how to configure the HyDE way linking the manual page of each package, e.g. waybar, Hyprland.

• Theming

• Scripts (or a name best describes the scripts that has an interface )
This discusses stuff like e.g how to utilize the built in scripts, wallpaper.sh. This will be in a Man page format.
NOTE: I discouraged documenting every script, like every script just for the contributor. Man page for users should be enough for them to understand the gist. It's a maintenance burden.

• ... more