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

[Feature] Docs as repo rather than wiki #246

Closed
clsty opened this issue Feb 8, 2024 · 5 comments
Closed

[Feature] Docs as repo rather than wiki #246

clsty opened this issue Feb 8, 2024 · 5 comments

Comments

@clsty
Copy link
Collaborator

clsty commented Feb 8, 2024

What would you like to be added?
Currently the docs are in the wiki of this repo, which is not open to edit, and it does not support pull request even if you make it open to edit.

Method A:
You may create another repo dots-hyprland-docs just for docs for this repo, and add me as a collaborator for that repo, because I like maintaining docs and you seems busy sometimes, so that I can handle documenting for you.

As for publishing, there're 2 methods.

A.a:
Some *.mds will be just enough.

A.b:
Similar to the doc repo of ags, we can use GitHub Pages and Astro and Starlight, so that searching across different docs is enabled, and also a modern look is provided.

If you trust me, you may just create that empty repo named dots-hyprland-docs and enable github pages in settings of that repo (use GitHub Actions as source), and add me as a collaborator, and I'll do the rest of things (including copying markdown files from wiki of this repo, arrange the files, edit workflow files, etc.).

Method B:
You may arrange document files inside a docs folder, so that people can contribute to docs.


How will it help
I've noticed that the wiki is kind of... basic, and not covering some rather important how-to-s and why-s.

If it's open to contribute, I guess people using this repo will contribute to the docs so that the usage and trouble shooting will be more comprehensive.
Therefore, people will be less likely to ask duplicated questions (such as #211 (comment)).

Also you may add docs for development as a note for yourself and other maintainers/contributors.


Extra info
I've already collected some FAQs here.

@end-4
Copy link
Owner

end-4 commented Feb 9, 2024

https://github.com/end-4/dots-hyprland-wiki
I sent a collaborator invite @clsty

@clsty
Copy link
Collaborator Author

clsty commented Feb 9, 2024

https://github.com/end-4/dots-hyprland-wiki I sent a collaborator invite @clsty

Nice.
BTW today is Chinese New Year's Eve, therefore the wiki will not be completely ready very quickly.

@clsty clsty closed this as completed Feb 9, 2024
@end-4
Copy link
Owner

end-4 commented Feb 9, 2024

same thing here in vietnam haha
no rush, quality is priority

@clsty
Copy link
Collaborator Author

clsty commented Feb 9, 2024

Do you mind if I use your avatar as favicon for that wiki? @end-4

I guess we should not use the logo of hyprland, since it may violate with the law, I'm not sure.

Or just no favicon.

If you want to use some favicon file, you may put it inside the repo as public/favicon.ico or public/favicon.svg, and I'll handle the rest of thing.

@end-4
Copy link
Owner

end-4 commented Feb 9, 2024

sure my avatar should be good for now
i'll change it later if i decide to design a logo for illogical impulse

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

No branches or pull requests

2 participants