[Question] Rewriting the Stable Baseline Docs with MkDocs with good UI and UX

[Siddhu2502]

❓ Question

I am working on rewriting the Stable Baseline docs using MkDocs, and I will add few new features.

• I will be adding tagging features to help categorize contributions and make them easier to find.
• Additionally, I will be adding support for multiple languages, including English, Chinese, and French, to make the documentation more accessible to users around the world.
• I will also be incorporating features such as toggling between dark and light mode, a table of contents, and versioning navigation.
• If you have any suggestions or feedback, please let me know.

Checklist

• I have checked that there is no similar issue in the repo
• I have read the documentation
• If code there is, it is minimal and working
• If code there is, it is formatted using the markdown code blocks for both code and stack traces.

[Siddhu2502]

@araffin can you help me out ?

[araffin]

Hello,
do you already have a live draft somewhere?
apart from the rst format, what are the main issues with the current documentation according to you?

[Siddhu2502]

hii sorry for the late reply,

I do have a small draft when i was tinkering with mkdocs i understood how powerfull it can be i can make a small live draft in 2 days of time and put it in my github pages (currently updating my website too)

the main reason

• Limited customization options in the readthedocs (the things i want to and will be adding in the docs )

1. features like toggling between light and dark mode
2. faster search bar results
3. changing themes (not the light and dark mode but font family and other thing)
4. better navigation (inside page navigation and topic wise navigation)
5. readability
6. versioning

• Formatting limitations

1. the rst file format itself is very very complicated unlike md file which is widely used ig its atleast for me i struggle with writing in the rst format

few things i wanted to point out are there furthermore we can add a live comment section with the mkdocs plugin but i have to work on it to do it properly. If this is approved i would love to have a companion to do the job or doing solo also is fine by me but i will take a little longer

thanks

[Siddhu2502]

@araffin sorry for the delayed reply please check it out