hyprspace icon indicating copy to clipboard operation
hyprspace copied to clipboard

Wiki?

Open Winterhuman opened this issue 2 years ago • 2 comments

There is a lot of people who like to use hyprspace but don't know how some of it works on a lower level.

For instance, your explanation for how authentication works in hyprspace was something very useful and interesting to me, I think creating a Wiki section to explain how certain parts of hyprspace work (both for users and developers) would be extremely useful and could help bring more pull requests from new contributers. Particularly why certain solutions were chosen over others and other information that isn't mentioned in the code's comments.

Let me know what you think, I realise this could end up being a lot to maintain with each release, but, I think it could be worthwhile overall.

Winterhuman avatar Oct 25 '21 20:10 Winterhuman

Absolutely! I think this is a great idea and I've been thinking of writing some more expansive documentation for Hyprspace for a while now. I've previously written two other documentation sites for the other projects I work on. (arken.io/docs & autamus.io/docs) Are you thinking something in a similar format to those or something different?

alecbcs avatar Oct 26 '21 04:10 alecbcs

I was thinking either having the wiki be on hyprspace.io itself or to use Github's wiki page feature, which ever one is easy for you. I think Arken's and Autamus's Wiki pages are exactly what I imagined.

Winterhuman avatar Oct 26 '21 10:10 Winterhuman