docs(readme): misc doc change

uesteibar / neuron

A GraphQL client for Elixir

https://hex.pm/packages/neuron

Other

331 stars 35 forks source link

docs(readme): misc doc change #67

Closed kianmeng closed 3 years ago

kianmeng commented 3 years ago

Besides other documentation changes, this commit ensures the generated HTML doc for HexDocs.pm will become the source of truth for this Elixir library and leverage on latest features of ExDoc.

uesteibar commented 3 years ago

Hi @kianmeng! What's the actual purpose of this PR? Which ExDoc features is it leveraging that it wasn't before? I'm not an expert on ExDocs but I can't really see it

kianmeng commented 3 years ago

@uesteibar Every relevant documentation is consolidated into one place at HexDocs.pm, see table of content in the screenshot below:

Screenshot-20210718172245-440x830

Let me know if you've further questions.

uesteibar commented 3 years ago

ah that looks good! merging 👍