search

hanami / ecosystem

Hanami Ecosystem
12 stars 3 forks source link

Improve hanami doc site #4

Open davydovanton opened 7 years ago

davydovanton commented 7 years ago

Now I have simple hanami-doc repository. I used sdoc for generation it.

What we want to do

I think it will be cool to add YARV support to sdoc. After that, we can replace my repository to hanami org and use this.

Any ideas how we can do it?

jodosha commented 7 years ago

@davydovanton I was thinking about the same thing, but this goes beyond the scope of the ecosystem.

If you want to go ahead, we should have a separated repository to generate the API docs from YARD. We can create http://docs.hanamirb.org for this purpose.

Docs should be versioned with major and minor release number eg: /v1.0. Each versioned path should contain a full blown documentation generated from all the gems.