Mollie elixir documentation suggestions and ideas

[wolfiton]

Hi everyone,

Overview

Repo for the project: https://github.com/jarroput/mollie , created by jarroput

So i will start first with what I want to do and explain the overview of the situation:

1. Create a documentation by creating an example for mollie payment gateway for a phoenix template setup

2. Create a documentation by creating an example for mollie payment gateway for a phoenix absinthe setup

So any advice regarding database schema, any requests you might have please post them below.

Side note: This is my first time doing something like this so any tools or best practices on documenting and creating an example for this kind of project is appreciated.

Docs that are so far: https://hexdocs.pm/mollie/api-reference.html , this doc is created by jarroput

Update:

Tests: what kind of tests go well with a documentation example:

end to end testing or just cover 80% of the code?

Thanks in advance

[wolfiton]

Does anyone have any input or advice on this?

[wolfiton]

Can someone recommend a similar project that has great documentation with examples in elixir phoenix?

Resources that i found:

What are the attributes of good documentation in Elixir?

There is this section in the Elixir docs that talks about documentation. I would say it mostly covers how to effectively use ExDoc. But in the spirit of the library guidelines, what should our documentation guidelines be? To kick things off: What should/shouldn’t be in a project README/@moduledoc/@doc? What public functions shouldn’t be documented? What should/shouldn’t have type specs? When should you document your types for type specs? How do you document a GenServer? (e.g. child_spec, star…

https://hexdocs.pm/elixir/writing-documentation.html

https://elixirschool.com/en/lessons/basics/documentation/

Writing documentation in Elixir | What did I learn

https://medium.com/podiihq/writing-documentation-for-elixir-projects-and-serving-it-on-localhost-92ae07f7f5bb

https://ericdouglas.github.io/2017/08/27/elixir-built-in-documentation-and-testing-tools/

Today I Learned

I am posting them maybe others will find them useful

Thanks

[peter-de-boer]

I am considering using that repo and would be happy to see some more documentation on how to use that library. Have you had the opportunity to write something?