Docs

[darkofabijan]

I would like to create ex_docs site for Phoenix. It would work pretty much the same way as it works for Elixir. Make script would assume that ex_doc is installed in ../ex_doc and it would for generate docs for master (for now) and store in the ../docs. I guess we could host it through GitHub pages. @chrismccord can you please create docs repository?

I got inspiration for this while writing docs for routes scope macro and seeing that we could improve in this area. It's easier to evaluate docs through generated html docs.

[ericmj]

You can add ex_doc as a dependency and use the mix docs instead of requiring the ex_doc executable in ../ex_doc. If you don't want to impose the dependency on users you can add it as a conditional dependency as done here: https://github.com/elixir-lang/ecto/blob/master/mix.exs#L29.

[darkofabijan]

Ah awesome! Thanks for the tip @ericmj :)

[chrismccord]

@darkofabijan Here you go: https://github.com/phoenixframework/docs

Having great docs from the start is something we want to strive for. It's easy to get caught up on the code churn so good thinking.

[darkofabijan]

Tnx!