Active_model_serializers: Should we have an ams.github.io page for our docs?

[NullVoxPopuli]

That way our docs could still be versioned / tracked with git, and we'd be able to embed runnable examples via something like repl.it or something.

[bf4]

cc @remear

My preference is that all docs should be able to be changed as part of a PR, so that they don't get out of sync. This would be similar to the Rails Guides pattern, which builds them manually.

We could write a webhook build the docs and push to a gh-pages branch when a PR is merged.

[NullVoxPopuli]

I like that idea. I'll see what options are available for doing that tomorrow morning. :-)

[NullVoxPopuli]

this could be a good tool: http://couscous.io/docs/
travis setup: http://couscous.io/docs/travis.html

not sure how I feel about it being php based though.

this could also work: https://github.com/tripit/slate/wiki/Deploying-Slate (it's written in ruby)
this is a common one, too: https://github.com/jekyll/jekyll and endorsed by github

[remear]

The short answer here is, probably, in the sense that there's a high likelihood the generated documentation will be served by GitHub pages. I'm still working on a solution to the docs issue on a larger scale.