docs: improve configuration documentation format#180
Open
repparw wants to merge 1 commit intoKZDKM:mainfrom
Open
docs: improve configuration documentation format#180repparw wants to merge 1 commit intoKZDKM:mainfrom
repparw wants to merge 1 commit intoKZDKM:mainfrom
Conversation
Author
|
This was almost completely done by Copilot, so I don't know if the default values of each option are actually okay. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR improves the README configuration documentation to better match Hyprland's documentation style:
Changes Made
plugin:overview:prefix from table entries and added clear instruction that options go underplugin:overviewThe new format makes it much easier for users to understand and configure the plugin, following the same patterns as Hyprland's official documentation.
Closes #179