sled icon indicating copy to clipboard operation
sled copied to clipboard

Move doc module to mdbook?

Open LordMZTE opened this issue 4 years ago • 0 comments

Hey, I've seen that sled seems to have a lot of documentation which isn't directly related to rust code in the doc module. I think that's pretty unusual, and I would find it easier to read through, and better organized if it were seperate from the rustdoc.

The solution that many rust developers use for this is mdbook. Many big rust libraries (such as serde or druid) use mdbook for documentation, best practices and guides as well, what about doing so too? The current content of the doc module should also be pretty easy to tranfer to mdbook, as theyre both markdown.

LordMZTE avatar Jun 20 '21 23:06 LordMZTE