mirror of
https://github.com/run-llama/llama_deploy.git
synced 2026-07-19 23:04:27 -04:00
Create Initial Docs #5
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @logan-markewich on GitHub (Jun 22, 2024).
Originally assigned to: @logan-markewich on GitHub.
A new docs site likely needs to be spun up. This should include at a minimum some basic installation, getting started, and a few guides.
Additionally, we need some API docs, which means writing a lot of docstrings (or getting copilot to help 😉)
@peteryxu commented on GitHub (Jul 7, 2024):
would love to contribute to agent docs writing/generating, and site publishing. Let me know how I could get started. @logan-markewich
@logan-markewich commented on GitHub (Jul 8, 2024):
@peteryxu while trying to avoid having too many docs sites, considering integrating the docs into llama-index docs.
I'm thinking the docs will mostly live in this repo, and the build step for the llama-index docs will clone this and copy over some info
Still need to try and get that working 😅
For docs in general, I'd really like to focus on a good quickstart (maybe the current readme isnt good enough), theory/structure overview, api docs (so good docstrings, since it's generated from that) and good examples.
@peteryxu commented on GitHub (Jul 8, 2024):
that's sounds a good plan. I can start thinking about some good quickstarts, and arch overview.
@peteryxu commented on GitHub (Jul 8, 2024):
For general DocOps automation & process, have you looked at https://www.komment.ai/#product ? @logan-markewich
@masci commented on GitHub (Oct 11, 2024):
Docs are now available at https://docs.llamaindex.ai/en/latest/module_guides/llama_deploy/ we can call this issue done, will open a new one in case later we want to have a dedicated website to serve Llama Deploy docs exclusively