Skip to content
New issue

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

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

Already on GitHub? # to your account

create github wiki for the documentation #26

Open
dqrk0jeste opened this issue Jan 16, 2025 · 2 comments
Open

create github wiki for the documentation #26

dqrk0jeste opened this issue Jan 16, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@dqrk0jeste
Copy link
Owner

owl is currently documented through the example.conf file, but i think it would be easier if we had a really simple website with all the configuration options, and also with some other info about the compositor, like layouts, workspaces and general workflow guides.

is anyone interested in doing so? i DON'T want it to be anything complicated, so no react or other things, just some simple non-interactive html pages, maybe using hugo or something

if anyone is interested leave a comment down below :)

@dqrk0jeste dqrk0jeste added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Jan 16, 2025
@amatsagu
Copy link
Contributor

amatsagu commented Jan 16, 2025

I can do that in spare time. Probably not sooner than in 2 weeks thought.

Do you wish to use any specific language or library? Or maybe I should just write a bit of classic HTML/CSS code, have fully static files with no vodoo magic. Other idea is to create basic website skeleton and have all docs written as markdown documents, then with a bit of javascript download & display them on website on each page reload.

Basically up to discussion. We can rely on free github pages just fine I think.

I can also think of some logo, similar like SwayFX or Hyprland have, nothing too detailed. You called project "Owl" - assuming you want to keep it, I'll look at owl animal references, maybe some moon shapes too, etc. about color - either 1 solid color or 2-3 colors mixed in gradient for simplicity, blue is already kinda taken by hyprland so I would suggest warm red (like a fireplace cracking in night) or purple? (something more mysterious?)

Edit: It may be a good idea to move this repository from your person and create organization under project name where we can pack it all. A lot of projects do it like this for easier management. This way we could have owl/owl and owl/website for example.

Edit (2): Thinking of either nocturnal bird (owl), moon, night and colors higher suggested - I got that idea that no matter what will be selected in the end, maybe trying warm red color going into pink + glow/neon effect on it could look cool. I would have to test it but it may actually look decent and also show that this project places effort on eye candy things as well.

@dqrk0jeste
Copy link
Owner Author

after thinking a bit today, i realized it would be easier to use github wiki for the documentation. its easier and quicker to setup and also easier to maintain later.

when it comes to logo, all ideas are welcome. there should probably be an owl somewhere (for obvious reason) and i am leaning towards a that blue-purple variant, but every submission or idea is welcome.

@dqrk0jeste dqrk0jeste changed the title make a simple website for the documentation create github wiki for the documentation Jan 18, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants