search

obsidian-rs / obsidian

Ergonomic async http framework for reliable and efficient web
MIT License
26 stars 4 forks source link

Documentation #35

Open jk-gan opened 4 years ago

jk-gan commented 4 years ago

As we want to improve developer experience, we need to have a good documentation. Rust has one of the best official documentation as well.

Can refer to this thread

jk-gan commented 4 years ago

One of the suggestions is using Docusaurus v2 (still in alpha)

jk-gan commented 4 years ago

There are few must have topics:

plwai commented 4 years ago

If we wanted to follow the style within Rust community. mdbook is a good choice.

jk-gan commented 4 years ago

I will prefer Docusaurus as it can be the website as well, or we can make the Tutorial in mdbook.

plwai commented 4 years ago

I think for API specification Docusaurus and Rust Docs do it well. mdbook is better for tutorial and deep dive into the framework.