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

fix/docs #792

Merged
merged 1 commit into from
Oct 28, 2024
Merged

fix/docs #792

merged 1 commit into from
Oct 28, 2024

Conversation

sohamganatra
Copy link
Contributor

@sohamganatra sohamganatra commented Oct 28, 2024

Important

Update image path in crewai.mdx and improve documentation clarity in quickstart.mdx and introduction.mdx.

  • Image Path Update:
    • Update image source path in crewai.mdx from GitHub URL to relative path.
  • Documentation Improvements:
    • Remove redundant CLI note in quickstart.mdx.
    • Simplify authentication examples in quickstart.mdx by removing specific user references.
    • Add "Introduction to Key Concepts" section in introduction.mdx to explain workspace environments, custom tools, and benchmarks.

This description was created by Ellipsis for 25bfa03. It will automatically update as commits are pushed.

Copy link

vercel bot commented Oct 28, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
composio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 28, 2024 2:25pm

@sohamganatra sohamganatra merged commit 2469e26 into master Oct 28, 2024
4 of 5 checks passed
@sohamganatra sohamganatra deleted the fix/docs branch October 28, 2024 14:24
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Reviewed everything up to 25bfa03 in 21 seconds

More details
  • Looked at 119 lines of code in 3 files
  • Skipped 0 files when reviewing.
  • Skipped posting 3 drafted comments based on config settings.
1. docs/framework/crewai.mdx:8
  • Draft comment:
    Ensure the relative path 'framework/media/crewai_composio.png' is correct and the image is accessible. If the image is not loading, consider reverting to the absolute URL.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR changes the image source path from an absolute GitHub URL to a relative path. This change should be verified for correctness.
2. docs/introduction/intro/quickstart.mdx:26
  • Draft comment:
    Consider retaining the note about the CLI binary package for users who might rely on it. Removing it could lead to confusion for those expecting CLI support.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The comment should address the removal of the CLI note, which might be important for users who rely on CLI.
3. docs/introduction/intro/quickstart.mdx:128
  • Draft comment:
    Consider retaining the note about the CLI binary package for users who might rely on it. Removing it could lead to confusion for those expecting CLI support.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The comment should address the removal of the CLI note, which might be important for users who rely on CLI.

Workflow ID: wflow_qHyfx8shGmdVEFN0


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link

This comment was generated by github-actions[bot]!

JS SDK Coverage Report

📊 Coverage report for JS SDK can be found at the following URL:
https://pub-92e668239ab84bfd80ee07d61e9d2f40.r2.dev/coverage-11556036618/coverage/index.html

📁 Test report folder can be found at the following URL:
https://pub-92e668239ab84bfd80ee07d61e9d2f40.r2.dev/html-report-11556036618/html-report/report.html

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

Successfully merging this pull request may close these issues.

1 participant