Provide quality docstrings and API documentation

[MarcSkovMadsen]

To help understand and use Lumen AI it would help a lot with better docstrings and API documentation.

For example take a look at the DocumentLookup.

Just a simple example in the docstring of using this would be very, very helpful.

The API documentation explains only 3 of the 9 arguments/ parameters. What about the rest?

What does "all available documents" refer to?

[MarcSkovMadsen]

Another example. It would have been quite helpful with docstring api documentation and an example here. I'm quite lost.

As a user I don't care it extends another class. That is an implementation detail and may change. I don't know anything about intake - I'm using lumen-ai. Please provide something in a language I have a background for understanding as a user of lumen-ai.

[ahuang11]

I wonder if we should migrate Lumen to mkdocs.

After a boilerplate mkdocs.yml and docs/ai/reference.md later:

# Reference

::: lumen.ai.actor
::: lumen.ai.agents
::: lumen.ai.coordinator
::: lumen.ai.tools

Results in a very neat docs page that is cross-linked and also source code (that isn't perfect but can be configured I think):

Clipboard-20250204-045854-307.mp4

[MarcSkovMadsen]

I'm all for migrating to mkdocs in general.