Please add an API reference section in the docs

[Gilad Barnea]

Edit: TLDR, link to api ref docs: https://declarai.com/reference/declarai/

---

First of all, thanks for declarai! It's been a breeze to use and experiment with so far.

A documented API reference of all the objects and their signatures would be really helpful. Without it, I default to looking at the source.

A good example in my opinion is Rich's docs:

https://rich.readthedocs.io/en/stable/console.html

Thanks!

[Gilad Barnea]

RestructuredText supports dynamic "auto" documentation from source code. I'd check if that works with MkDocs

[Gilad Barnea]

Another thought: would probably be good for newcomers if the link for @task API would be mentioned rather high up the main README, e.g before the "Why Declarai?".
"For @task's API click here"

[Matan Kleyman]

Thanks for raising that. Definitely agree it's a must.
How about using something like mkdocs strings ? https://github.com/mkdocstrings/mkdocstrings

Would you like to collaborate on that ?

[Gilad Barnea]

@matankley That's really cool, didn't know that existed.
I'd be happy to collaborate but I can't promise I'll find the time.
If you guys broke it down to 2-3 small first tasks, I'd save me the relatively time-consuming step of loading the project's context into my mind for the first time.
You could post those as Issues with label: "good first issue". That's a common way to lower the contribution entry barrier in general.

[Gilad Barnea]

Here it is. Thanks!
https://declarai.com/reference/declarai/