Adding docs infra - Githubissues

NeowayLabs / neosearch

Full Text Search Library

30 stars 4 forks source link

Adding docs infra #15

Closed katcipis closed 9 years ago

katcipis commented 9 years ago

Right now the workflow is:

Generating docs:

make docs

Viewing docs:

make docs-view

Debug the docs env:

make docs-shell

We have integration of markdown + go code + swagger API. Seems enough for a start :-).

The REST API right now is for a pet store :P, it is a sample that should help us to have an idea on how to document stuff.

coveralls commented 9 years ago

Coverage remained the same at 52.38% when pulling 482efdcb333ee9204a29433de33248b53517c83c on addingDocsInfra into 96f522b1382fead9a4e4b4def7a49a644b95b809 on master.