fix: actions docs #866
fix: actions docs #866
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
👍 Looks good to me! Reviewed everything up to e4b4d86 in 45 seconds
More details
- Looked at
263lines of code in5files - Skipped
0files when reviewing. - Skipped posting
6drafted comments based on config settings.
1. docs/patterns/actions/action-guide-faqs.mdx:11
- Draft comment:
The language identifier in the code block is redundant since the language is already specified in the comment. Consider removing it for consistency.
- Reason this comment was not posted:
Confidence changes required:50%
The PR includes several instances where the language identifier in code blocks is redundant. The language is already specified in the comment, so it should be removed from the code block identifier.
2. docs/patterns/actions/action-guide-faqs.mdx:18
- Draft comment:
The language identifier in the code block is redundant since the language is already specified in the comment. Consider removing it for consistency.
- Reason this comment was not posted:
Confidence changes required:50%
The PR includes several instances where the language identifier in code blocks is redundant. The language is already specified in the comment, so it should be removed from the code block identifier.
3. docs/patterns/actions/action-guide-faqs.mdx:31
- Draft comment:
The language identifier in the code block is redundant since the language is already specified in the comment. Consider removing it for consistency.
- Reason this comment was not posted:
Confidence changes required:50%
The PR includes several instances where the language identifier in code blocks is redundant. The language is already specified in the comment, so it should be removed from the code block identifier.
4. docs/patterns/actions/action-guide-faqs.mdx:47
- Draft comment:
The language identifier in the code block is redundant since the language is already specified in the comment. Consider removing it for consistency.
- Reason this comment was not posted:
Confidence changes required:50%
The PR includes several instances where the language identifier in code blocks is redundant. The language is already specified in the comment, so it should be removed from the code block identifier.
5. docs/patterns/actions/action-guide-faqs.mdx:62
- Draft comment:
The language identifier in the code block is redundant since the language is already specified in the comment. Consider removing it for consistency.
- Reason this comment was not posted:
Confidence changes required:50%
The PR includes several instances where the language identifier in code blocks is redundant. The language is already specified in the comment, so it should be removed from the code block identifier.
6. docs/patterns/actions/action-guide-without-agents.mdx:22
- Draft comment:
The language identifier in the code block is redundant since the language is already specified in the comment. Consider removing it for consistency.
- Reason this comment was not posted:
Confidence changes required:50%
The PR includes several instances where the language identifier in code blocks is redundant. The language is already specified in the comment, so it should be removed from the code block identifier.
Workflow ID: wflow_fqpy8jAGl2EX1evK
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
|
This comment was generated by github-actions[bot]! JS SDK Coverage Report📊 Coverage report for JS SDK can be found at the following URL: 📁 Test report folder can be found at the following URL: |
| @@ -25,47 +25,12 @@ const tools = await toolset.getTools({actions: ['github_issues_create','github_c | |||
|
|
|||
| </Accordion> | |||
|
|
|||
There was a problem hiding this comment.
The removal of the "How do I find an Action for my Use Case?" section might reduce the documentation's helpfulness. Consider keeping this section or integrating its content into other parts of the document to maintain comprehensive guidance for users.
There was a problem hiding this comment.
Yes, there is already an entire section on Finding Actions by Use Case so removed the accordion.
|
|
||
| <Tabs> | ||
| <Tab title="Python"> | ||
| Yes, you can filter and get Actions in an App based on tags. |
There was a problem hiding this comment.
Great improvement in code formatting and clarity. Consider adding brief explanations for each code example to further enhance understanding for users.
There was a problem hiding this comment.
yes, added descriptions.
| @@ -68,4 +68,4 @@ agent_executor.invoke({"input": task}) | |||
| </CodeGroup> | |||
|
|
|||
| This code demonstrates how to use LLMs to execute an action. | |||
| Composio supports multiple frameworks for creating Agents including LlamaIndex, CrewAI, Letta, Langchain, you can see it in the **Supported Frameworks** section. | |||
| Composio supports multiple frameworks for creating Agents including LlamaIndex, CrewAI, Letta, LangChain, you can see it in the **Supported Frameworks** section. | |||
There was a problem hiding this comment.
Good correction of "Langchain" to "LangChain". Consider adding brief descriptions of each mentioned framework (LlamaIndex, CrewAI, Letta, LangChain) to provide more context for users who might be unfamiliar with these tools.
There was a problem hiding this comment.
this section is related to actions & there are independent section explaining each famework so didn't repeat it again here.
| @@ -9,6 +9,58 @@ description: "Perform Actions with your account or on behalf of your users witho | |||
|
|
|||
| Composio lets you perform actions with your account or on behalf of your users. Feel free to check all the [tools](https://app.composio.dev/apps) we support. | |||
|
|
|||
| ### Get Parameters for an Action | |||
There was a problem hiding this comment.
The new "Get Parameters for an Action" section is a valuable addition. Consider adding:
- A brief explanation of why and when users might need to get parameters for an action.
- A text-based alternative or summary of the video content for accessibility and quick reference.
|
|
||
|
|
||
| <Tip> | ||
| Custom Actions can be created for any existing tool in Composio, allowing you to tailor the functionality to your specific needs while leveraging the existing authentication. | ||
| Custom Actions are flexible building blocks that let you create any functionality you need - from simple calculations to complex integrations. They work seamlessly with Composio's authentication system for existing tools, or can run independently for custom logic. |
There was a problem hiding this comment.
The improved description of Custom Actions is clearer and more comprehensive. To further enhance this section, consider adding one or two concrete examples of custom actions to illustrate their potential applications.
There was a problem hiding this comment.
Yes, I'm going to revamp this section.
docs/patterns/actions/usecase.mdx
Outdated
| @@ -11,14 +11,14 @@ Find relevant actions for your use case by describing what you want to accomplis | |||
|
|
|||
|
|
|||
| <CodeGroup> | |||
| ```Python Python Fetch Actions using use-case | |||
| ```Python Python | |||
There was a problem hiding this comment.
The code formatting improvements in this file enhance readability. Consider adding more context or explanation around these use case examples to help users understand how to apply them effectively in their projects.
|
Overall, this PR significantly improves the documentation for Composio actions. Here's a summary of the changes and some general suggestions:
General suggestions for further improvement:
These changes significantly enhance the documentation's quality and usefulness. Great work on improving the user experience for working with Composio actions! |
There was a problem hiding this comment.
👍 Looks good to me! Incremental review on fcd04fa in 15 seconds
More details
- Looked at
36lines of code in1files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. docs/patterns/actions/action-guide-without-agents.mdx:32
- Draft comment:
Ensure code block titles are consistent across all examples for clarity. For example, use "Python" and "JavaScript" without additional text like "Star a repo" or "Get Hypermedia links in GitHub". - Reason this comment was not posted:
Confidence changes required:50%
The code block titles in the CodeGroup sections are inconsistent. They should be consistent for clarity.
Workflow ID: wflow_Zye2ZtBOMbckm0y0
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
…lter by usecase) | remove faqs page
There was a problem hiding this comment.
❌ Changes requested. Incremental review on 2aa6025 in 28 seconds
More details
- Looked at
289lines of code in1files - Skipped
0files when reviewing. - Skipped posting
0drafted comments based on config settings.
Workflow ID: wflow_Umdbpg10MT7NNq13
Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
| As `gmail` toolname is already registered in Composio, `auth` dictionary will be automatically provided! | ||
| </Note> | ||
| <CodeGroup> | ||
| ```python Custom Action - Gmail (python) | ||
| ```python Python |
There was a problem hiding this comment.
The requests and datetime modules are used but not imported. Add import requests and import datetime at the beginning of the Python code block.
There was a problem hiding this comment.
👍 Looks good to me! Incremental review on 4ce6ca0 in 36 seconds
More details
- Looked at
119lines of code in2files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. docs/mint.json:94
- Draft comment:
The path "introduction/foundations/components/custom_actions" should be updated to "patterns/tools/custom_actions" to reflect the file restructuring. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable:
The comment is not related to any change made in the diff. The path mentioned in the comment was not altered in the diff, so the comment is not relevant to the changes made.
I might be missing some context about the overall file structure changes, but based on the diff alone, the comment is not relevant.
The task is to focus on the diff provided, and the comment does not pertain to any change in the diff. Therefore, it should be removed.
Remove the comment as it is not related to any change made in the diff.
Workflow ID: wflow_YC5IN3FBW7XXP3t9
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
There was a problem hiding this comment.
👍 Looks good to me! Incremental review on 2d5ecbc in 33 seconds
More details
- Looked at
389lines of code in6files - Skipped
0files when reviewing. - Skipped posting
2drafted comments based on config settings.
1. docs/patterns/tools/build-tools/custom-action-for-new-tool.mdx:24
- Draft comment:
Consider using consistent naming conventions for JavaScript imports across examples. For instance,OpenAIToolSetis used here, whileLangchainToolSetis used in other examples. Consistency helps in understanding and reduces confusion. - Reason this comment was not posted:
Confidence changes required:50%
The code examples in the documentation files use inconsistent naming conventions for JavaScript imports. This can lead to confusion for users trying to follow the examples.
2. docs/patterns/tools/use-tools/use-specific-actions.mdx:23
- Draft comment:
Consider using consistent naming conventions for JavaScript imports across examples. For instance,LangchainToolSetis used here, whileOpenAIToolSetis used in other examples. Consistency helps in understanding and reduces confusion. - Reason this comment was not posted:
Confidence changes required:50%
The code examples in the documentation files use inconsistent naming conventions for JavaScript imports. This can lead to confusion for users trying to follow the examples.
Workflow ID: wflow_3CVvAXcThv36PWv5
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
There was a problem hiding this comment.
👍 Looks good to me! Incremental review on 90ca8a3 in 14 seconds
More details
- Looked at
187lines of code in3files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. docs/patterns/tools/use-tools/processing-actions.mdx:59
- Draft comment:
Consider providing a placeholder or a note indicating that JavaScript examples will be added in the future to avoid confusion. - Reason this comment was not posted:
Confidence changes required:50%
The JavaScript section is marked as 'coming soon', which might be confusing for users expecting JavaScript examples.
Workflow ID: wflow_uWoiTqf8LYFKLZbr
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
There was a problem hiding this comment.
👍 Looks good to me! Incremental review on 7b68930 in 1 minute and 2 seconds
More details
- Looked at
186lines of code in2files - Skipped
0files when reviewing. - Skipped posting
3drafted comments based on config settings.
1. docs/patterns/tools/use-tools/configure-tools.mdx:44
- Draft comment:
The closing parenthesis for theComposioToolSetinitialization is missing. Add it to ensure the code is correct.
)
- Reason this comment was not posted:
Comment looked like it was already resolved.
2. docs/patterns/tools/use-tools/configure-tools.mdx:56
- Draft comment:
The closing parenthesis for theget_toolsfunction call is missing. Add it to ensure the code is correct.
)
- Reason this comment was not posted:
Comment looked like it was already resolved.
3. docs/patterns/tools/use-tools/configure-tools.mdx:89
- Draft comment:
The closing parenthesis for theComposioToolSetinitialization is missing. Add it to ensure the code is correct.
)
- Reason this comment was not posted:
Marked as duplicate.
Workflow ID: wflow_XTATYNEGzrr9uUfy
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
There was a problem hiding this comment.
👍 Looks good to me! Incremental review on 98ab37b in 25 seconds
More details
- Looked at
51lines of code in1files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. docs/patterns/tools/use-tools/processing-actions.mdx:234
- Draft comment:
Missing closing parenthesis for theget_tools()method call.
actions=[Action.TWITTER_CREATION_OF_A_POST]
)
- Reason this comment was not posted:
Comment was on unchanged code.
Workflow ID: wflow_gTLuYq2hsnYTiQ4r
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
Important
Enhances Composio documentation with examples, sections for executing, creating, and finding actions, and restructures files for clarity.
action-guide-faqs.mdx.action-guide-without-agents.mdx.action-guide-with-agents.mdxandaction-guide-without-agents.mdx.custom_actions.mdx.usecase.mdx.action-guide-with-agents.mdxtotools/action-guide-with-agents.mdx.action-guide-without-agents.mdxtotools/action-guide-without-agents.mdx.custom_actions.mdxtotools/custom_actions.mdx.usecase.mdxtotools/filter-actions.mdx.tools/what-are-tools.mdxto explain tools and actions.This description was created by
for 98ab37b. It will automatically update as commits are pushed.