Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Add plasma-manager documentation generation #278

Merged
merged 8 commits into from
Jul 30, 2024
Merged

Add plasma-manager documentation generation #278

merged 8 commits into from
Jul 30, 2024

Conversation

magnouvean
Copy link
Collaborator

The documentation for this project is known for being somewhat lacking. This aims to fix this by adding a documentation/manual which is automatically built on each commit to trunk. This manual includes an options-page which lists all the available options supported in plasma-manager, as mentioned in #192.

A working preview can a.t.m. be found at https://magnouvean.github.io/plasma-manager (this will probably be deleted after this pr is closed). Feedback for this would be great. I reckon if there are no major complaints that I merge this in a couple days. I'm not 100% sure the action will work on this repo since this is under nix-community (it's hard to know beforehand, but the action is pretty much identical to the one in home-manager, so hopefully there's no problem there).

@HeitorAugustoLN
Copy link
Member

Great work! It is looking great.

@HeitorAugustoLN
Copy link
Member

In the future we could probably add this for widget options too.

@magnouvean
Copy link
Collaborator Author

Yes, though we'd probably need to quite creative with a solution for this since lib.evalModules wouldn't work in that case (since widget options aren't modules). We could probably get something working though eventually.

@magnouvean magnouvean merged commit 110d50c into nix-community:trunk Jul 30, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants