crewAI icon indicating copy to clipboard operation
crewAI copied to clipboard

Please update your documentation

Open SayliJain opened this issue 1 year ago • 7 comments

SayliJain avatar Dec 24 '24 06:12 SayliJain

Find a working example (writing a book with flows is working, 100% guaranteed) Most likely, you'll have to tweak import paths Internalize it and build from there.

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.

JaDenis avatar Dec 24 '24 08:12 JaDenis

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?

s-arkal avatar Dec 24 '24 08:12 s-arkal

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 there won't be any docs worth your time in the future (it will all be generated meh bullshit), better get used to it p.s. excuse my pessimism

JaDenis avatar Dec 24 '24 08:12 JaDenis

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.

tonykipkemboi avatar Dec 26 '24 06:12 tonykipkemboi

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 It does't use method annotations @crew @start @agent etc.. So now it's down to me to figure out how annotations work under the hood and implement something similar to async workflows. It's not compatible.

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? This doesn't say anything: "This systematic workflow enhances project outcomes by ensuring tasks are handled with optimal efficiency and accuracy"

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.

gabus avatar Jan 01 '25 13:01 gabus

Thanks for the info. We will update the annotations section with examples today.

tonykipkemboi avatar Jan 03 '25 15:01 tonykipkemboi

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

gabus avatar Jan 08 '25 17:01 gabus

Another example how documentation let down someone https://www.reddit.com/r/crewai/comments/1fro9b6/crewkickoff_doesnt_pass_inputs_argument_into_agent/

gabus avatar Jan 10 '25 11:01 gabus

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.

tonykipkemboi avatar Jan 10 '25 15:01 tonykipkemboi

Another very bad example is this one https://docs.crewai.com/tools/scrapewebsitetool Technically I don't thing it's even possible to use this tool together with CrewAI annotations. Since there's no way to pass in arguments into agents, hence a tool. I don't think I explained this well, but just try creating full working example

gabus avatar Jan 10 '25 16:01 gabus

This issue is stale because it has been open for 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

github-actions[bot] avatar Feb 10 '25 12:02 github-actions[bot]

This issue was closed because it has been stalled for 5 days with no activity.

github-actions[bot] avatar Feb 16 '25 12:02 github-actions[bot]