-
Notifications
You must be signed in to change notification settings - Fork 1k
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
[Documentation] Move all wiki pages into the repo and make it pretty #2494
Conversation
This is great! I think we should ignore the third bullet point for now as it could significantly sidetrack the PR. I will review this in more detail when I can. |
I agree @yamanq , the review can take place after this PR. I just wrote it down for notekeeping (it was 3am when I opened the PR :D ) I just tried to do a theme and it can work, but CSS is just not my thing. I was able to get the general view (like sidebar and main site) to kinda look like the Github Dark theme, but then you also have to "darkify" all the tables, code snippets and so on. So maybe someone craftier with that stuff can do it. I'm gonna add the base for a theme to the PR but not switch to it yet, so people can just do the css instead of also having to prepare other things in daux. A simple config line switch should do it then. |
I also retract my initial statement: It has to be it's own workflow since the path trigger that I just introduced only works on workflow level. So in order for the documentation build only to happen when actual documentation is changed, it needs it's own workflow. So no workflow-integration needed here. |
So @em92 : Things to do for this to work (in order):
Theming and review can take place in a second PR but both would need the PR to be merged anyways (so that changes can be done to them). |
@em92 anything missing? |
I think this is great. Having the docs side by side with the code in git is the way to go in my opinion. |
Greetings,
This should fix #2356
I used the time while watching a stupid movie to move all wiki files to .md files and setup github pages automation and documentation generation using daux.io.
I have done a bit of "quality checking" but it's mostly a copy of the current wiki content.
You will need to setup a github pages site and then adapt the workflow (maybe integrate the step with another workflow that is already running anyways and will look for folder updates)
You can already see this working here: https://bockiii.github.io/rss-bridge/index.html
Todo (and looking for volunteers):
I invite you all for comments and help with the todos