Documentation should be available from GitHub pages

eproxus / meck

A mocking library for Erlang

http://eproxus.github.io/meck

Apache License 2.0

811 stars 231 forks source link

Documentation should be available from GitHub pages #173

Open kvelicka opened 7 years ago

kvelicka commented 7 years ago

I think that having to generate your own documentation is somewhat unwieldy -- would it be possible to publish an online version on http://eproxus.github.io/meck/?

eproxus commented 7 years ago

I totally agree to this, and it has bothered me many times 😄

I see a couple of different ways of doing this:

Use Edown to generate at least markdown that exists in the GitHub repo and later push that to the GitHub site
Just generate Edoc HTML and publish that to the GitHub site.
Publish docs to Hexdocs

I have some plans to migrate to Rebar3 in the near future, once I've solved the issues with Hamcrest (it's not Rebar3 compatible), and maybe this will become easier then.

If you have any other suggestions, I'd be more than willing to hear them!

eproxus commented 7 years ago

Hexdocs publishing is now enabled for future versions. Here's the first version: https://hexdocs.pm/meck/0.8.7/

I'll still try to do something with Edown as well, because it would be nice to have the docs as Markdown on the home page, so I'll leave this issue open for now...

dcsommer commented 6 years ago

+1 would be nice to have easy access from the github homepage :) Thanks for meck by the way!

darkling commented 4 years ago

I didn't even know that there was API documentation until I decided to file an issue about it and found this one.

junhaodong commented 3 years ago

Looks like the Online Documentation link from https://hex.pm/packages/meck is currently broken.

Visiting full URL (https://hexdocs.pm/meck/0.9.0/index.html) works (but you may have to click on "meck" in left nav bar), but it does not work for latest 0.9.1

eproxus commented 3 years ago

@junhaodong It should be fixed now. Let me know if you have any other issues.

Regarding the bigger issue, I plan to do a revamp of the README and the GitHub pages “soon”. Feedback for any specific wishes is very welcome!

paulo-ferraz-oliveira commented 3 years ago

@eproxus: shall we open a separate issue to track that action?

I can think of a few minor suggestions:

[ ] remove references to specific versions from the README (e.g. 0.8.0)
[ ] add more example (with a link from README) in an examples folder
[ ] move the compile+eunit instructions to something more generic (for example, I use ct much more than eunit - and compile is automatic, already)
[ ] Test Output: I'd make it more generic (since testing could be described elsewhere) or get rid of it completely
[ ] I'd section the Caveats section

eproxus commented 3 years ago

@paulo-ferraz-oliveira Really nice list! Mirrors some of my thoughts already. Let’s keep the list here for the time being.

jpaton commented 3 years ago

Online documentation is broken again on Hex at https://hex.pm/packages/meck

eproxus commented 3 years ago

@jpaton Sigh, still the Rebar doc bug. Thanks for the heads up. Should be fixed now!