Skip to content
This repository has been archived by the owner on Oct 29, 2021. It is now read-only.

Documentation #35

Open
jk-gan opened this issue Jan 6, 2020 · 5 comments
Open

Documentation #35

jk-gan opened this issue Jan 6, 2020 · 5 comments
Assignees
@jk-gan @plwai
Labels
enhancement Enchancement for current feature help wanted Extra attention is needed
Projects
Obsidian
Milestone
v0.3

Comments

@jk-gan
Copy link
Member

jk-gan commented Jan 6, 2020 •
edited
Loading

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 jk-gan added enhancement Enchancement for current feature help wanted Extra attention is needed labels Jan 6, 2020
@jk-gan
Copy link
Member Author

jk-gan commented Jan 6, 2020

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

@jk-gan jk-gan added this to the V0.2 milestone Jan 6, 2020
@jk-gan jk-gan added this to To do in Obsidian via automation Jan 6, 2020
@jk-gan jk-gan mentioned this issue Jan 6, 2020
Closed
10 tasks
@jk-gan
Copy link
Member Author

jk-gan commented Jan 6, 2020 •
edited
Loading

There are few must have topics:

  • Get Started (installation, how to run a demo app)
  • Tutorial (build a real world app, including database)
  • Advance Tutorial (custom middleware, custom responder, custom error)

@plwai
Copy link
Member

plwai commented Jan 6, 2020

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

@jk-gan
Copy link
Member Author

jk-gan commented Jan 6, 2020

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

@plwai
Copy link
Member

plwai commented Jan 6, 2020

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

@jk-gan jk-gan mentioned this issue Apr 24, 2020
Open
11 tasks
@jk-gan jk-gan modified the milestones: V0.2, v0.3 Apr 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@jk-gan jk-gan

@plwai plwai

Labels
enhancement Enchancement for current feature help wanted Extra attention is needed
Projects
Obsidian
  
To do
Milestone
v0.3
Development

No branches or pull requests
2 participants
@jk-gan @plwai