Improve documentation

[lpil]

Hi there!

I'm enjoying Elli after switching a couple projects to it from Cowboy.

My main problem has been lack of documentation, for example I needed to read the source code to determine how to use middleware (and I feel I'm still missing many of the details).

I feel this results in Elli being less accessible and less likely to be used, especially to people who are more used to Elixir rather than Erlang. Could we improve the docs? Perhaps include a series of examples in the README?

I'd be happy to help here.

Cheers, Louis

[deadtrickster]

Hi,

you totally right! we need more examples and use-cases. Personally I don't have much time for this unfortunately. But if you decide to contribute I'll be happy to discuss and merge.

[lpil]

Cool. Where would you like me to put them?

[deadtrickster]

I think starting with extending REAME would be good enough. complete app(s) can go to a separate directory.

[yurrriq]

I wouldn't mind a separate elli-lib repo even.

[lpil]

Hi @yurrriq, could you make an elli-example repo please? I'll make a pull request there afterwards :)

[deadtrickster]

https://github.com/elli-lib/elli-example

[lpil]

examples would be better than example unless we only want one example per repo.

I was imagining many small ones in there for users to read without getting lost in a big app

[lpil]

Also this seems to hand been closed prematurely, the documentation is still very sparse.

[deadtrickster]

I closed this issue accidentally

[lpil]

Thanks @deadtrickster ! :)

[lpil]

Me again, sorry. I don't seem to be able to make a PR until there is a first commit. Could you perhaps make a commit with an empty README or such?

[tsloughter]

@lpil looks like there is one now.

Also, we should publish docs to hex. I'm fine putting all docs in edoc stuff and publishing to hex for everything, but we could also consider something like readme.io.

[lpil]

Aye, I've made some PRs since :)

Documentation on hexdocs would be fantastic from my point of view

[yurrriq]

Hmm.. looks like something's gone wrong with the last couple times publishing to hexdocs. Not my wheelhouse, though I'd be happy to look into it. Ideally we can fix this for 4.0

[paulo-ferraz-oliveira]

@lpil, a bit late to the party, but... is that repo. enough for what you envisioned? (I know you're busy with other stuff) I was just wondering if there's the need to update in the scope of this issue, or it could be closed (?) The one I linked doesn't solve all issues, of course, it just moves to ex_doc 😄

[lpil]

I'm sorry but I've not given this any thought in recent years!