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

[Documentation] Move all wiki pages into the repo and make it pretty #2494

Merged
merged 6 commits into from
Mar 22, 2022

Conversation

Bockiii
Copy link
Contributor

@Bockiii Bockiii commented Mar 12, 2022

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):

  • Come up with a nicer (aka darker) color scheme for the page. It's easily customizable ( https://daux.io/For_Developers/Creating_a_Theme.html ) but I'm not the visual guy. I just know that the light theme burns my eyes.
  • Check references to "wiki" and pages that might be located somewhere else now. I already fixed all links, but haven't read through it all.
  • Review the actual content. Some of the info is years old (aka 4 years and older since the last touch in the wiki) so it might be out of date.

I invite you all for comments and help with the todos

@yamanq
Copy link
Contributor

yamanq commented Mar 13, 2022

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.

@Bockiii
Copy link
Contributor Author

Bockiii commented Mar 13, 2022

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.

@Bockiii
Copy link
Contributor Author

Bockiii commented Mar 13, 2022

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.

@Bockiii
Copy link
Contributor Author

Bockiii commented Mar 14, 2022

So @em92 : Things to do for this to work (in order):

  1. Merge the PR. This will do one workflow run of the "documentation" flow that will generate the "gh-pages" branch in the rss-bridge repo.
  2. Go to the repo settings, activate pages and set them like this:
    image
    (branch "gh-pages", folder /root)
  3. A workflow named "pages-build-deployment" should start to run (its a github default one and wont show in the workflows directory) and publish the site at rss-bridge.github.io

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).

@Bockiii
Copy link
Contributor Author

Bockiii commented Mar 18, 2022

@em92 anything missing?

@dvikan
Copy link
Contributor

dvikan commented Mar 20, 2022

I think this is great. Having the docs side by side with the code in git is the way to go in my opinion.

This was referenced Mar 21, 2022
@Bockiii Bockiii merged commit 76f5de3 into RSS-Bridge:master Mar 22, 2022
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.

TODO: Move all wiki pages except "Public Hosts" to repository.
3 participants