Improve generated Elixir docs - Githubissues

aws-beam / aws-codegen

Code generator for AWS clients in Erlang and Elixir.

Other

53 stars 49 forks source link

Improve generated Elixir docs #57

Closed philss closed 3 years ago

philss commented 3 years ago

This PR aims to improve the documentation for the aws-elixir package. The idea is to remove unnecessary HTML tags and improve the markdown that is generated by aws-codegen.

Comparison

You can compare the two by accessing the following links:

Before (or the current version): https://hexdocs.pm/aws/
After (or the version from this PR): https://tmp-aws-docs-elixir-5mfrk3rt2.vercel.app/ (based in ed0ac8b).

:point_right: The auto generated Elixir code can be found in https://github.com/aws-beam/aws-elixir/pull/46

:yellow_circle: A PR covering the Erlang docs is coming soon.

This closes #55