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

Please update your documentation #1800

Open
SayliJain opened this issue Dec 24, 2024 · 10 comments
Open

Please update your documentation #1800

SayliJain opened this issue Dec 24, 2024 · 10 comments
Assignees
Labels
feature-request New feature or request

Comments

@SayliJain
Copy link

SayliJain commented Dec 24, 2024

No description provided.

@SayliJain SayliJain added the feature-request New feature or request label Dec 24, 2024
@SayliJain SayliJain changed the title [FEATURE] MAYBE UPDATE YOUR STUPID DOCS Please update your documentation Dec 24, 2024
@JaDenis
Copy link

JaDenis commented Dec 24, 2024

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.

@s-arkal
Copy link

s-arkal commented Dec 24, 2024

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?

@JaDenis
Copy link

JaDenis commented Dec 24, 2024

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

@tonykipkemboi
Copy link
Contributor

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.

@gabus
Copy link

gabus commented Jan 1, 2025

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.

@tonykipkemboi
Copy link
Contributor

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

@gabus
Copy link

gabus commented Jan 8, 2025

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

gabus commented Jan 10, 2025

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

@tonykipkemboi
Copy link
Contributor

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 tonykipkemboi self-assigned this Jan 10, 2025
@gabus
Copy link

gabus commented Jan 10, 2025

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants