Documentation

[1Jajen1]

trafficstars

I decided to finally start documentation for this. I expect this to take about 1-4 weeks depending on how well preparing for exams goes.

Reviews are much appreciated at any point in time as writing docs is not something I do a lot of^^

Oh and with this there are only a few other tasks to go to make this library fully usable:

• [ ] Provide interface with arrow-fx-coroutines or switch to using it directly
• [ ] Update kotest in the kotlintest module

Nice to have:

• [ ] merge #7 or better even split it and incrementally improve testing. This should only be done after updating kotlintest and deciding on what to do with arrow-fx-coroutines

[1Jajen1]

@rachelcarmena Is this way of structuring documentation correct or is there something else that I need to do?

[nomisRev]

I decided to finally start documentation for this. I expect this to take about 1-4 weeks depending on how well preparing for exams goes.

Very excited about this library in the Kotlin eco-system! 👏 👏 And good luck with your exams @1Jajen1! 🤞🙌

[rachelcarmena]

@rachelcarmena Is this way of structuring documentation correct or is there something else that I need to do?

Thanks @1Jajen1 !! It look very good to me.

Then it will be necessary to add these pages into the website sidebar menu: https://github.com/arrow-kt/arrow-site#how-to-add-a-menu-entry

By the way, arrow-docs project is configured and the API is being generated and validated. However, you can see this result now:

> Task :arrow-docs:runAnk
      :::     ::::    ::: :::    :::
    :+: :+:   :+:+:   :+: :+:   :+:
   +:+   +:+  :+:+:+  +:+ +:+  +:+
  +#+     ++: +#+ +:+ +#+ +#++:++
  +#+     +#+ +#+  +#+#+# +#+  +#+
  #+#     #+# #+#   #+#+# #+#   #+#
  ###     ### ###    #### ###    ###
Current heap used: 6.6 MiB
Starting ank with Heap Size: 184.0 MiB, Max Heap Size: 2.7 GiB
Ank Processed 0 files

because there aren't code snippets to validate because of using:

```kotlin

instead of:

```kotlin:ank

You can find more details in this guide: https://github.com/arrow-kt/arrow/blob/master/docs/libraries/how-to-generate-and-validate-documentation.md

Despite the links, please, let me know if I can help you :raised_hands:

[1Jajen1]

And good luck with your exams @1Jajen1!

:see_no_evil: Worst ones are over so... :)

By the way, arrow-docs project is configured and the API is being generated and validated. However, you can see this result now

Yeah ank is definitely a goal. I need to change some config stuff so that ank will run the no-color version and find a good layout option for the output. This is all trivially tweakable, all it needs is a good way of hiding it from docs.

Then it will be necessary to add these pages into the website sidebar menu: https://github.com/arrow-kt/arrow-site#how-to-add-a-menu-entry

I was not aware that we have documentation for our documentation! (Bad puns aside, this is great, especially the ability to locally run it. And I am sure you have mentioned this before somewhere as well and I just keep forgetting :see_no_evil: )

[1Jajen1]

I got side-tracked with all the continuation stuff and stm... Time to pick this up again^^