Fix issue #648 and add QOL Readability Improvements #650
Conversation
This PR adds some quality-of-life readability improvements and fixes iv-org#648.
This PR adds quality-of-life readability improvements and fixes Issue iv-org#648.
docs/companion-installation.md
Outdated
| @@ -2,13 +2,13 @@ | |||
|
|
|||
| After installation take a look at the [Post-install steps](#post-install-configuration). | |||
|
|
|||
| Note: Any [PaaS](https://en.wikipedia.org/wiki/Platform_as_a_service) or [SaaS](https://en.wikipedia.org/wiki/Software_as_a_service) provider/software (Heroku, YunoHost, Repli...) are unsupported. Use them at your own risk. They **WILL** cause problems with Invidious and might even suspend your account for "abuse" since Invidious is heavy, bandwidth intensive and technically a proxy (and most providers don't like them). If you use one and want to report an issue, please mention which one you use. | |||
| >[!Note] | |||
There was a problem hiding this comment.
mkdocs does not support Markdown alerts
There was a problem hiding this comment.
Ha yes you need to use the features from mkdocs material theme: https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage
like from >[!Note]
to !!! note
docs/companion-installation.md
Outdated
| @@ -216,15 +231,16 @@ exit | |||
| su - invidious | |||
| cd invidious | |||
| make | |||
| ``` | |||
| #### Configure config/config.yml as you like | |||
There was a problem hiding this comment.
You could do the same thing you did here but for the MacOS section bellow since they are kinda similar ;)
docs/companion-installation.md
Outdated
| @@ -2,13 +2,13 @@ | |||
|
|
|||
| After installation take a look at the [Post-install steps](#post-install-configuration). | |||
|
|
|||
| Note: Any [PaaS](https://en.wikipedia.org/wiki/Platform_as_a_service) or [SaaS](https://en.wikipedia.org/wiki/Software_as_a_service) provider/software (Heroku, YunoHost, Repli...) are unsupported. Use them at your own risk. They **WILL** cause problems with Invidious and might even suspend your account for "abuse" since Invidious is heavy, bandwidth intensive and technically a proxy (and most providers don't like them). If you use one and want to report an issue, please mention which one you use. | |||
| >[!Note] | |||
There was a problem hiding this comment.
Ha yes you need to use the features from mkdocs material theme: https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage
like from >[!Note]
to !!! note
docs/companion-installation.md
Outdated
| cd invidious | ||
| ``` | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
I'm sorry please do not touch any of the code block formatting, this will not look great on https://docs.invidious.io/companion-installation/
Don't touch the positioning of those code blocks.
There was a problem hiding this comment.
Sorry I did this because the markdown alerts looked terrible on GitHub while the code was indented. I'll just remove the markdown alerts as it seems it's not compatible with most markdown standards anyway.
There was a problem hiding this comment.
I'll just adjust the admonitions to work with the chosen theme.
This PR rewords the Invidious Companion Guide to be more authoritative and corrects grammar. It also adds mkdocs compatible callouts and increases readability.
|
I spent some significant time on this to make it more readable and it was easier to follow for me, but if you reject it. I totally understand. |
|
Thanks, I'll take a look at it more closely when I'll have time. Could you please test if that works great on the final version by launching mkdocs, the doc is here: https://github.com/iv-org/documentation#running-the-documentation-locally-for-development-purposes. Either use pip or docker. Thank you! |
|
Will do |
This PR adds quality-of-life readability improvements and fixes #648.