search

SeawolvesAtCali / prisel

Making a online monopoly game
MIT License
5 stars 2 forks source link

Markdown doc generation #90

Open yiochen opened 5 years ago

yiochen commented 5 years ago

Sumary Try generating docs using tools like markdown-magic and jsdoc-to-markdown

yiochen commented 5 years ago

typescript documentations follows tsdoc spec. There is a doc gen library typedoc. However, both libraries are in early stages. Ideally, I want a tool that can start from an entry file, generate documents for all exported members that user has access to. But we can do that yet with typedoc.

I also realize that users don't usually read API docs in order. API doc generated from code usually serves as a look up reference when users need more information on one specific API. More important documentations are tutorials and guides.

I will push this to 0.3 milestone, let's wait for typedoc to get more mature.