{"action":"created","issue":{"url":"https://api.github.com/repos/potatosalad/erlang-jose/issues/8","labels_url":"https://api.github.com/repos/potatosalad/erlang-jose/issues/8/labels{/name}","comments_url":"https://api.github.com/repos/potatosalad/erlang-jose/issues/8/comments","events_url":"https://api.github.com/repos/potatosalad/erlang-jose/issues/8/events","html_url":"https://github.com/potatosalad/erlang-jose/pull/8","id":106687627,"number":8,"title":"Begin documenting the Elixir API","user":{"login":"cs-victor-nascimento","id":7049728,"avatar_url":"https://avatars.githubusercontent.com/u/7049728?v=3","gravatar_id":"","url":"https://api.github.com/users/cs-victor-nascimento","html_url":"https://github.com/cs-victor-nascimento","followers_url":"https://api.github.com/users/cs-victor-nascimento/followers","following_url":"https://api.github.com/users/cs-victor-nascimento/following{/other_user}","gists_url":"https://api.github.com/users/cs-victor-nascimento/gists{/gist_id}","starred_url":"https://api.github.com/users/cs-victor-nascimento/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cs-victor-nascimento/subscriptions","organizations_url":"https://api.github.com/users/cs-victor-nascimento/orgs","repos_url":"https://api.github.com/users/cs-victor-nascimento/repos","events_url":"https://api.github.com/users/cs-victor-nascimento/events{/privacy}","received_events_url":"https://api.github.com/users/cs-victor-nascimento/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2015-09-16T02:51:19Z","updated_at":"2015-09-18T21:35:42Z","closed_at":"2015-09-18T21:32:42Z","pull_request":{"url":"https://api.github.com/repos/potatosalad/erlang-jose/pulls/8","html_url":"https://github.com/potatosalad/erlang-jose/pull/8","diff_url":"https://github.com/potatosalad/erlang-jose/pull/8.diff","patch_url":"https://github.com/potatosalad/erlang-jose/pull/8.patch"},"body":"This is an initial attempt at documenting the Elixir API of the erlang-jose library. I still have to find more time to dig in deeper on the API to understand its structures.\r\n\r\nAlthough incomplete, this has the base for publishing it to hex and linking the docs to the version. If you run:\r\n\r\n```elixir\r\nMIX_ENV=docs mix do deps.get, compile\r\nMIX_ENV=docs mix docs\r\n```\r\n\r\nYou will see something like:\r\n![screenshot from 2015-09-15 23 44 23](https://cloud.githubusercontent.com/assets/7049728/9895241/b876846a-5c03-11e5-9513-2c9257d1ba83.png)\r\n\r\nAfter that is just a matter of issuing:\r\n\r\n```elixir\r\nMIX_ENV=docs mix hex.docs\r\n```\r\n\r\nAnd Hex will show a \"(docs)\" link. \r\n\r\n@potatosalad What do you think of starting small? This might be helpful in a future version release where people will get more insightful messages from `h JOSE.JWK.verify` in the shell or IDEs. "},"comment":{"url":"https://api.github.com/repos/potatosalad/erlang-jose/issues/comments/141574745","html_url":"https://github.com/potatosalad/erlang-jose/pull/8#issuecomment-141574745","issue_url":"https://api.github.com/repos/potatosalad/erlang-jose/issues/8","id":141574745,"user":{"login":"potatosalad","id":1804,"avatar_url":"https://avatars.githubusercontent.com/u/1804?v=3","gravatar_id":"","url":"https://api.github.com/users/potatosalad","html_url":"https://github.com/potatosalad","followers_url":"https://api.github.com/users/potatosalad/followers","following_url":"https://api.github.com/users/potatosalad/following{/other_user}","gists_url":"https://api.github.com/users/potatosalad/gists{/gist_id}","starred_url":"https://api.github.com/users/potatosalad/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/potatosalad/subscriptions","organizations_url":"https://api.github.com/users/potatosalad/orgs","repos_url":"https://api.github.com/users/potatosalad/repos","events_url":"https://api.github.com/users/potatosalad/events{/privacy}","received_events_url":"https://api.github.com/users/potatosalad/received_events","type":"User","site_admin":false},"created_at":"2015-09-18T21:35:42Z","updated_at":"2015-09-18T21:35:42Z","body":"@cs-victor-nascimento The initial version of the documentation is available here: http://hexdocs.pm/jose/1.2.0/overview.html"}}