search

ComposioHQ / composio

Composio equip's your AI agents & LLMs with 100+ high-quality integrations via function calling
https://docs.composio.dev
Other
7.48k stars 2.33k forks source link

Added SWE Docs #362

Closed sohamganatra closed 1 month ago

sohamganatra commented 1 month ago

PR Type

Documentation

Description

Changes walkthrough 📝

Relevant files
Documentation
mint.json
Add SweKit group and pages to documentation structure       
docs/mint.json
  • Added a new group SweKit with pages for introduction, workspace
    environments, and benchmarks.
  • Removed unnecessary blank lines.
    		•  +8/-2     
    benchmarks.mdx
    Add benchmarks documentation for SweKit                                   
    docs/swekit/benchmarks.mdx
  • Added a new document for benchmarks in SweKit.
  • Included sections on running benchmarks, workspace environments, and
    implementation details.
    		•  +98/-0   
    introduction.mdx
    Add introduction documentation for SweKit                               
    docs/swekit/introduction.mdx
  • Added an introduction document for SweKit.
  • Included sections on key features, getting started, and next steps.
    		•  +100/-0 
    workspace-env.mdx
    Add workspace environments documentation for SweKit           
    docs/swekit/workspace-env.mdx
  • Added a new document for workspace environments in SweKit.
  • Included sections on supported environments and configuring workspace
    environments.
    		•  +149/-0 

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    codiumai-pr-agent-pro[bot] commented 1 month ago

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review
    codiumai-pr-agent-pro[bot] commented 1 month ago

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Possible issue
    Correct the URLs for the "Guides" and "Examples" sections to match their intended destinations ___ **It appears that the URLs for the "Guides" and "Examples" sections might have been
    mistakenly swapped during the update. Ensure that the URLs correctly reflect the
    intended destinations for each section.** [docs/mint.json [63-68]](https://github.com/ComposioHQ/composio/pull/362/files#diff-c91a604899dfef4b2494c317f4fd39a7f22b79986095f580399347293d534debR63-R68) ```diff { "name": "Guides", - "url": "patterns" + "url": "guides" }, { "name": "Examples", - "url": "guides" + "url": "patterns" } ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 9 Why: The suggestion correctly identifies a potential mix-up in the URLs for the "Guides" and "Examples" sections, which could lead to navigation issues. Fixing this is crucial for maintaining the accuracy of the documentation.
    		9
    Enhancement
    Refactor the "pages" array in the "SweKit" group to use objects with "name" and "url" properties for consistency ___ **The newly added "SweKit" group should include a consistent structure for the "pages"
    array, similar to other sections. Each page should be an object with "name" and
    "url" properties instead of plain strings to maintain consistency and structure in
    the JSON file.** [docs/mint.json [160-165]](https://github.com/ComposioHQ/composio/pull/362/files#diff-c91a604899dfef4b2494c317f4fd39a7f22b79986095f580399347293d534debR160-R165) ```diff { "group": "SweKit", "pages": [ - "swekit/introduction", - "swekit/workspace-env", - "swekit/benchmarks" + {"name": "Introduction", "url": "swekit/introduction"}, + {"name": "Workspace Environment", "url": "swekit/workspace-env"}, + {"name": "Benchmarks", "url": "swekit/benchmarks"} ] } ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 8 Why: This suggestion improves the consistency and structure of the JSON file, making it easier to maintain and understand. It aligns the new "SweKit" group with the existing format used in other sections.
    		8
    Provide a default value for in the benchmark running instructions to enhance clarity ___ **Replace the placeholder with a default value or example in the code snippet to
    avoid confusion and ensure the code is executable without modifications. This change
    enhances usability and clarity for users trying to run the benchmarks.** [docs/swekit/benchmarks.mdx [30]](https://github.com/ComposioHQ/composio/pull/362/files#diff-b6b7331e72dcee19843fac55608034e0f32d9e5f9570265ecdcbb3347f4ac64dR30-R30) ```diff -python benchmark.py --test_split= +python benchmark.py --test_split=1:100 # Example: Running 100 test instances ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 7 Why: Adding a default value for `` improves usability by providing a clear example, reducing potential confusion for users trying to run the benchmarks.
    		7
    Replace the placeholder with an example to improve clarity in the agent creation instructions ___ **In the "Create a New Agent" step, clarify the placeholder to enhance understanding.
    Suggest using a specific example path or a more descriptive placeholder.** [docs/swekit/introduction.mdx [64]](https://github.com/ComposioHQ/composio/pull/362/files#diff-3db961a3457d97a55cee70418b4bba90cf948c4c82a024fc86e8afe9bb3a5241R64-R64) ```diff -swekit scaffold crewai -o +swekit scaffold crewai -o ./your_agent_directory # Example: specify the output directory for the agent ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 7 Why: Using a specific example for the `` placeholder enhances clarity and helps users understand where to specify the output directory, improving the overall user experience.
    		7