docs: more comprehensive docs #305
Conversation
| `llamactl` is a command line interface that ships with Llama Deploy and has the main goal to easily interact with a | ||
| running [API Server](./20_core_components.md#api-server). | ||
|
|
||
| ::: mkdocs-click |
There was a problem hiding this comment.
This structure makes sense to me (there's possibly some debate on module_guides vs/ understanding in our docs, but eh)
Probably once this merges, we can greatly simplify the README and point to this :)
There was a problem hiding this comment.
Yes, once the docs are available on the main website I would trim down the README to the minimum that makes more sense and point users there.
| For more details see [the Python API reference](../../api_reference/llama_deploy/apiserver.md), while the administrative | ||
| API is documented below. | ||
|
|
||
| !!swagger apiserver.json!! |
There was a problem hiding this comment.
Oh nice, I didn't realize this was possible
There was a problem hiding this comment.
It's a bit funky when I run it locally, sometimes it shows sometimes it doesn't, but it might be the local server. I'll keep an eye on its stability. Also we should find a way to remember (best would be automate) to update the openapi def when we change the fastapi routes 😅
There was a problem hiding this comment.
ha definitely -- there's probably some script we can write to dump this, maybe when calling the merge script in llama-index
There was a problem hiding this comment.
really cool! shows up for me when testing on local
| For more details see [the Python API reference](../../api_reference/llama_deploy/apiserver.md), while the administrative | ||
| API is documented below. | ||
|
|
||
| !!swagger apiserver.json!! |
There was a problem hiding this comment.
really cool! shows up for me when testing on local
docs/docs/module_guides/llama_deploy/30_manual_orchestration.md
Outdated
Show resolved
Hide resolved
For a preview, from the
docsfolder:then