search

run-llama / llama-agents

MIT License
1.29k stars 110 forks source link

Create Initial Docs #30

Open logan-markewich opened 3 weeks ago

logan-markewich commented 3 weeks ago

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 1 week ago

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 1 week ago

@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 1 week ago

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

peteryxu commented 1 week ago

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