-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Please update your documentation #1800
Comments
Find a working example (writing a book with flows is working, 100% guaranteed) here's legit way to get started with crewAi, reading docs won't be productive since its outdated and ai-generated on top of it. Don't be so entitled, you have to work for it in such a new field. |
I'm sorry, I have to agree with @SayliJain. The docs seem to be constantly out-of-date which is incredibly annoying when working with something novel. I don't get what you mean by "reading docs won't be productive"? Where else would one get their reference from? |
from working examples, code search on GitHub, asking guys in discord |
Hey what part of the docs are you specifically needing help with? We have a lot of sections that will be updated in the next few weeks, especially around tools and some of the advanced sections. In the meantime, happy to help on sections you're having issues with. Also checkout our forum. |
I'm struggling with docs as well. After building couple crews and workflows, I started reading about async executions. Docs don't even follow the same code design pattern. Check examples https://docs.crewai.com/how-to/kickoff-async Something similar goes to hierarchical process documentation. Examples cover bare minimum. How does manager_agent look like? Is there a possibility to fine tune managers? Overall, way more examples of different use cases would help a lot. Flows and Crews docs are good examples how every page should feel like. |
Thanks for the info. We will update the annotations section with examples today. |
I just noticed "Was this page helpful?" icons don't work at the bottom of the docs. I thing you'd get better idea if docs are helpful if you could keep track of them |
Another example how documentation let down someone https://www.reddit.com/r/crewai/comments/1fro9b6/crewkickoff_doesnt_pass_inputs_argument_into_agent/ |
tbf this is from the open source page on our website and not the docs. we will update that as well. thanks for your patience as we work on getting the docs updated. |
Another very bad example is this one https://docs.crewai.com/tools/scrapewebsitetool |
No description provided.
The text was updated successfully, but these errors were encountered: