search

ComposioHQ / composio

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

fix docs layout #350

Closed sohamganatra closed 1 month ago

sohamganatra commented 1 month ago

PR Type

Documentation

Description

Changes walkthrough 📝

Relevant files
Documentation
15 files
introduction.ipynb
Removed example notebook content                                                 
docs/guides/examples/introduction.ipynb - Removed the entire notebook content.
+0/-80   
research-assistant.mdx
Removed case study on research assistant                                 
docs/guides/casestudy/research-assistant.mdx - Deleted the entire case study document.
+0/-62   
install.mdx
Removed FAQ installation guide                                                     
docs/guides/faqs/install.mdx - Deleted the entire FAQ installation guide.
+0/-6     
gallery.mdx
Removed starter projects gallery                                                 
docs/guides/starterprojects/gallery.mdx - Deleted the entire starter projects gallery.
+0/-15   
install.mdx
Removed tutorials and guides installation document             
docs/guides/tutorials/install.mdx - Deleted the entire tutorials and guides installation document.
+0/-6     
ai.mdx
Removed AI & SaaS resources document                                         
docs/introduction/intro/resources/ai.mdx - Deleted the entire AI & SaaS resources document.
+0/-19   
pricing.mdx
Removed pricing document                                                                 
docs/introduction/pricing/pricing.mdx - Deleted the entire pricing document.
+0/-31   
startups-program.mdx
Removed startups program document                                               
docs/introduction/pricing/startups-program.mdx - Deleted the entire startups program document.
+0/-44   
mint.json
Updated documentation structure in mint.json                         
docs/mint.json
  • Removed SDK tab and related pages.
  • Reorganized the "More" group under the "tabs" section.
    		•  +7/-15   
    trigger.mdx
    Added documentation for using triggers                                     
    docs/python/trigger.mdx - Added a new document for using triggers in connected apps.
    		+84/-1   
    endpoints.mdx
    Removed documentation on HTTP endpoints                                   
    docs/sdk/composio/client/endpoints.mdx - Deleted the entire document on Composio API server HTTP endpoints.
    		+0/-48   
    enums.mdx
    Removed documentation on helper enum classes                         
    docs/sdk/composio/client/enums.mdx - Deleted the entire document on helper enum classes.
    		+0/-81   
    exceptions.mdx
    Removed documentation on HTTP client exceptions                   
    docs/sdk/composio/client/exceptions.mdx - Deleted the entire document on HTTP client exceptions.
    		+0/-40   
    http.mdx
    Removed documentation on HTTP client implementation           
    docs/sdk/composio/client/http.mdx
  • Deleted the entire document on HTTP client implementation for Composio
    SDK.
    		•  +0/-50   
    index.mdx
    Removed documentation on Composio SDK client                         
    docs/sdk/composio/client/index.mdx - Deleted the entire document on Composio SDK client.
    		+0/-513 

    💡 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: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    Incorrect Icon Removal
    The icon removal in the "More" group for JavaScript pages seems to be inconsistent. The icon is removed and then re-added, which might be an error. Group Name Change
    The group name "CLI API" was changed to "CLI" without any explanation. This could potentially break existing references or user expectations.
    codiumai-pr-agent-pro[bot] commented 1 month ago

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Possible issue
    Ensure the URL change in the "Guides" tab points to the correct resource or revert it if incorrect ___ **It seems that the URL for the "Guides" tab was changed from "sdk" to "patterns". If
    this URL change was intentional and you want to keep it as "patterns", ensure that
    this new URL correctly points to the intended resource. If "sdk" was the correct
    URL, revert this change to avoid breaking existing links.** [docs/mint.json [62]](https://github.com/ComposioHQ/composio/pull/350/files#diff-c91a604899dfef4b2494c317f4fd39a7f22b79986095f580399347293d534debR62-R62) ```diff -"url": "patterns" +"url": "sdk" ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 8 Why: This suggestion addresses a potential issue with the URL change that could break existing links if not intentional. Verifying the URL is crucial for maintaining correct navigation.
    		8
    Verify the existence of the newly added "python/trigger" page to avoid dead links ___ **The addition of "python/trigger" in the "More" group seems to be a new page. Ensure
    that this page exists and is correctly linked. If the page does not exist, remove
    this entry to avoid dead links.** [docs/mint.json [126]](https://github.com/ComposioHQ/composio/pull/350/files#diff-c91a604899dfef4b2494c317f4fd39a7f22b79986095f580399347293d534debR126-R126) ```diff -"python/trigger" +# If the page exists, no change needed. If not, remove the line. ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 7 Why: Ensuring that the newly added page exists is important to prevent dead links, which can negatively impact user experience.
    		7
    Consider reverting the change of the "group" name from "CLI API" to "CLI" if it affects functionality or clarity ___ **The "group" name was changed from "CLI API" to "CLI". If the original "CLI API"
    group name is more descriptive or was used for specific routing or grouping
    purposes, consider reverting this change to maintain clarity and functionality.** [docs/mint.json [159]](https://github.com/ComposioHQ/composio/pull/350/files#diff-c91a604899dfef4b2494c317f4fd39a7f22b79986095f580399347293d534debR159-R159) ```diff -"group": "CLI" +"group": "CLI API" ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 7 Why: The group name change could affect routing or clarity. Reverting it might be necessary to maintain the intended functionality and descriptive clarity.
    		7
    Maintainability
    Review the necessity of the "icon" attribute in the "More" group for consistency ___ **The "icon" attribute was added back to the "More" group under the "javascript"
    section. If this icon attribute is not required or was removed previously for a
    specific reason, consider removing it again to maintain consistency.** [docs/mint.json [148]](https://github.com/ComposioHQ/composio/pull/350/files#diff-c91a604899dfef4b2494c317f4fd39a7f22b79986095f580399347293d534debR148-R148) ```diff -"icon": "circle" +# If the icon is not needed, remove the line. ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 6 Why: This suggestion is about maintaining consistency in the code. While not critical, it helps in keeping the codebase clean and uniform.
    		6