search

discord-modmail / modmail

A Modmail bot for Discord. Allowing safe moderator conversations with server members one server at a time.
https://discord-modmail.readthedocs.io/
MIT License
15 stars 8 forks source link

feat: Documentation framework #39

Closed onerandomusername closed 3 years ago

onerandomusername commented 3 years ago

Is there an existing issue for this?

What is the feature?

Hosting documention.

Should be both current and to be implemented features.

@bast0006, I'm putting you in charge of getting the framework for this out there.

Would you like to implement this yourself?

No, someone else can implement it

Shivansh-007 commented 3 years ago

My suggestion is that we use MkDocs with the MkDocs Material Theme with GitHub Pages for hosting.

MkDocs Material theme provides several non-intrusive extensions for collapsible, tabs, and callouts that make the result documentation more readable, and a lot more. The FastAPI documentation is built on a few custom extensions, and you know how good documentation it is.

onerandomusername commented 3 years ago

Most of the documentation will be written on how to use the bot, not necessarily the code.

The one part of the code that hopefully will be autogenerated is the plugin framework.

Because of preview environments, I'd like to use cloudflare pages for hosting.