Skip to content
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

Create Initial Docs #30

Closed
logan-markewich opened this issue Jun 22, 2024 · 5 comments
Closed

Create Initial Docs #30

logan-markewich opened this issue Jun 22, 2024 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation P0

Comments

@logan-markewich
Copy link
Collaborator

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 😉)

@logan-markewich logan-markewich added documentation Improvements or additions to documentation P2 labels Jun 22, 2024
@peteryxu
Copy link
Contributor

peteryxu commented 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
Copy link
Collaborator Author

@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
Copy link
Contributor

peteryxu commented Jul 8, 2024

that's sounds a good plan. I can start thinking about some good quickstarts, and arch overview.

@peteryxu
Copy link
Contributor

peteryxu commented Jul 8, 2024

For general DocOps automation & process, have you looked at https://www.komment.ai/#product ? @logan-markewich

@logan-markewich logan-markewich self-assigned this Jul 9, 2024
@logan-markewich logan-markewich added P0 and removed P2 labels Jul 9, 2024
@masci
Copy link
Member

masci commented 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

@masci masci closed this as completed Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation P0
Projects
Status: Done
Development

No branches or pull requests

3 participants