chore/api docs

[nank1ro]

add the API docs

[codecov[bot]]

Codecov Report

Merging #77 (8ffaef6) into main (2d7a913) will not change coverage. Report is 1 commits behind head on main. The diff coverage is 100.00%.

:exclamation: Current head 8ffaef6 differs from pull request most recent head 880a435. Consider uploading reports for the commit 880a435 to get more accurate results

Additional details and impacted files

[](https://app.codecov.io/gh/nank1ro/solidart/pull/77?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandru+Mariuti) ```diff @@ Coverage Diff @@ ## main #77 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 20 20 Lines 1227 1224 -3 ========================================= - Hits 1227 1224 -3 ``` | [Files](https://app.codecov.io/gh/nank1ro/solidart/pull/77?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandru+Mariuti) | Coverage Δ | | |---|---|---| | [packages/solidart/lib/src/core/effect.dart](https://app.codecov.io/gh/nank1ro/solidart/pull/77?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandru+Mariuti#diff-cGFja2FnZXMvc29saWRhcnQvbGliL3NyYy9jb3JlL2VmZmVjdC5kYXJ0) | `100.00% <100.00%> (ø)` | | | [...ckages/solidart/lib/src/core/reactive\_context.dart](https://app.codecov.io/gh/nank1ro/solidart/pull/77?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandru+Mariuti#diff-cGFja2FnZXMvc29saWRhcnQvbGliL3NyYy9jb3JlL3JlYWN0aXZlX2NvbnRleHQuZGFydA==) | `100.00% <100.00%> (ø)` | | | [packages/solidart/lib/src/core/read\_signal.dart](https://app.codecov.io/gh/nank1ro/solidart/pull/77?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandru+Mariuti#diff-cGFja2FnZXMvc29saWRhcnQvbGliL3NyYy9jb3JlL3JlYWRfc2lnbmFsLmRhcnQ=) | `100.00% <100.00%> (ø)` | | | [packages/solidart/lib/src/core/resource.dart](https://app.codecov.io/gh/nank1ro/solidart/pull/77?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Alexandru+Mariuti#diff-cGFja2FnZXMvc29saWRhcnQvbGliL3NyYy9jb3JlL3Jlc291cmNlLmRhcnQ=) | `100.00% <100.00%> (ø)` | |