Propsal: Move docs from README to MkDocs

[Ra2-IFV]

Looks like the help docs are getting more complicated?

[中文 (默认, Beta 版本)](https://github.com/Simple-Tracker/qBittorrent-ClientBlocker/blob/dev/README.md) [English (Default, Beta Version)](https://github.com/Simple-Tracker/qBittorrent-ClientBlocker/blob/dev/README.en.md)
[中文 (Public 正式版)](https://github.com/Simple-Tracker/qBittorrent-ClientBlocker/blob/master/README.md) [English (Public version)](https://github.com/Simple-Tracker/qBittorrent-ClientBlocker/blob/master/README.en.md)

I suggest you use MkDocs to manage documentations. Demo with Material theme

[Simple-Tracker]

Good idea. But the project is becoming very slow at this stage, so this plan may be postponed until the project can start to be active in the future.

[Ra2-IFV]

I can help, so I created this discussion to get your permission
So where do we start? Create a docs folder under this repository, or use a new repo?

[Simple-Tracker]

I can help, so I created this discussion to get your permission
So where do we start? Create a docs folder under this repository, or use a new repo?

If you can help, that would be great. I prefer to use an existing repository for convenience.

[Ra2-IFV]

Okay, I'll fork

[Ra2-IFV]

I need some help:

Versioning

Do you need this? The docs can be versioned in two ways:

Use mike, a plugin for mkdocs, versioning is managed by mkdocs.
Use git, and have different docs in different branches (e.g master and dev).
I prefer the first one, and if possible but may not necessary, store it in a different repo

Multi language

Material for MkDocs has language selector widget, but it cannot change the nav bar because it's defined in the mkdocs.yml file:


There is a workaround for this.

[Simple-Tracker]

I need some help:

Versioning

Do you need this? The docs can be versioned in two ways:

Use mike, a plugin for mkdocs, versioning is managed by mkdocs. Use git, and have different docs in different branches (e.g master and dev). I prefer the first one, and if possible but may not necessary, store it in a different repo

Multi language

Material for MkDocs has language selector widget, but it cannot change the nav bar because it's defined in the mkdocs.yml file: ...

The documentation needs two versions: for the main branch (Release) and the dev branch (possibly beta).

Usually the commits of the main branch are only behind the dev branch, so if we can only maintain the documentation of the dev branch, it may reduce maintenance costs.

Regarding multilingualism, the navigation titles used by the current documentation include both languages, so it may not be necessary to use a workaround.