Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve hanami doc site #4

Open
davydovanton opened this issue Dec 23, 2016 · 1 comment
Open

Improve hanami doc site #4

davydovanton opened this issue Dec 23, 2016 · 1 comment

Comments

@davydovanton
Copy link
Member

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
Copy link
Member

jodosha commented Dec 23, 2016

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants