-
Notifications
You must be signed in to change notification settings - Fork 184
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh nice, I didn't realize this was possible
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
really cool! shows up for me when testing on local
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks really great. I like the structure that you've begun to layout for us here. I only had a few nits of some small things that I encountered during my reading.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
really cool! shows up for me when testing on local
For a preview, from the
docs
folder:then