Skip to content

Commit

Permalink
fix: actions docs (#866)
Browse files Browse the repository at this point in the history
<!-- ELLIPSIS_HIDDEN -->


> [!IMPORTANT]
> Enhances Composio documentation with examples, sections for executing,
creating, and finding actions, and restructures files for clarity.
> 
>   - **Documentation Enhancements**:
> - Added examples for selecting actions by ID and filtering by tags in
`action-guide-faqs.mdx`.
> - Introduced a section on getting parameters for actions in
`action-guide-without-agents.mdx`.
> - Added examples for executing actions with and without agents in
`action-guide-with-agents.mdx` and `action-guide-without-agents.mdx`.
> - Expanded on creating custom actions with examples for existing and
new tools in `custom_actions.mdx`.
> - Provided examples for finding actions by use case in `usecase.mdx`.
>   - **File Renames and Restructuring**:
> - Renamed `action-guide-with-agents.mdx` to
`tools/action-guide-with-agents.mdx`.
> - Renamed `action-guide-without-agents.mdx` to
`tools/action-guide-without-agents.mdx`.
>     - Renamed `custom_actions.mdx` to `tools/custom_actions.mdx`.
>     - Renamed `usecase.mdx` to `tools/filter-actions.mdx`.
>     - Added `tools/what-are-tools.mdx` to explain tools and actions.
>   - **Formatting and Clarity**:
>     - Removed redundant titles in code blocks across multiple files.
> - Improved descriptions and added tips for better understanding of
custom actions and use cases.
> 
> <sup>This description was created by </sup>[<img alt="Ellipsis"
src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=ComposioHQ%2Fcomposio&utm_source=github&utm_medium=referral)<sup>
for ec4b6c0. It will automatically
update as commits are pushed.</sup>


<!-- ELLIPSIS_HIDDEN -->

---------

Co-authored-by: Soham <[email protected]>
Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
  • Loading branch information
3 people authored Nov 22, 2024
1 parent 7170dc7 commit faa547b
Show file tree
Hide file tree
Showing 22 changed files with 776 additions and 678 deletions.
4 changes: 2 additions & 2 deletions docs/introduction/foundations/basic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ description: "Core Platform Modules"
Learn how to manage users and authentication, integrations!
</Card>

<Card color="#7bee0c" title="Actions Guide" icon="arrow-right" href="/patterns/actions/">
Learn how to use, execute, process and even create actions!
<Card color="#7bee0c" title="Tools Guide" icon="arrow-right" href="../../patterns/tools/what-are-tools/">
Learn how to use, execute, process and even create tools!
</Card>


Expand Down
102 changes: 0 additions & 102 deletions docs/introduction/foundations/components/actions/action-guide.mdx

This file was deleted.

83 changes: 0 additions & 83 deletions docs/introduction/foundations/components/actions/processing.mdx

This file was deleted.

80 changes: 0 additions & 80 deletions docs/introduction/foundations/components/custom_actions.mdx

This file was deleted.

4 changes: 2 additions & 2 deletions docs/introduction/intro/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Turn natural language into GitHub actions in minutes. Follow these 5 steps to st
```
</CodeGroup>
<Tip>
Composio also supports action executions without LLMs or agents. [Learn more](/patterns/actions/).
Composio also supports action executions without LLMs or agents. [Learn more](../../patterns/tools/use-tools/action-guide-without-agents).
</Tip>
</Step>

Expand Down Expand Up @@ -205,7 +205,7 @@ Turn natural language into GitHub actions in minutes. Follow these 5 steps to st
```
</CodeGroup>
<Tip>
Composio also supports action executions without LLMs or agents. [Learn more](/patterns/actions/).
Composio also supports action executions without LLMs or agents. [Learn more](../../patterns/tools/use-tools/action-guide-without-agents).
</Tip>
</Step>

Expand Down
2 changes: 1 addition & 1 deletion docs/introduction/intro/quickstart_3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ Integrate with popular agentic frameworks
<Card title="Authorize a User's Account" icon="brain" href="/introduction/foundations/components/entity/entity-guide">
Authorize a user's account to perform actions and subscribe to triggers
</Card>
<Card title="Execute Actions" icon="wand-magic-sparkles" href="/introduction/foundations/components/actions/action-guide">
<Card title="Execute Actions" icon="wand-magic-sparkles" href="../../patterns/tools/what-are-tools">
Execute actions on behalf of a user
</Card>
<Card title="Triggers" icon="bolt" href="/introduction/foundations/components/triggers/trigger-guide">
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction/intro/quickstart_3_backup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ Congratulations! You've just:
<Card title="Authorize a User's Account" icon="brain" href="/introduction/foundations/components/entity/entity-guide">
Authorize a user's account to perform actions and subscribe to triggers
</Card>
<Card title="Execute Actions" icon="wand-magic-sparkles" href="/introduction/foundations/components/actions/action-guide">
<Card title="Execute Actions" icon="wand-magic-sparkles" href="../../patterns/tools/what-are-tools">
Execute actions on behalf of a user
</Card>
<Card title="Triggers" icon="bolt" href="/introduction/foundations/components/triggers/trigger-guide">
Expand Down
46 changes: 29 additions & 17 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"colors": {
"primary": "#343434",
"light": "#fff",
"dark": "#9a4dff",
"dark": "#343434",
"ultraLight": "#9a4dff",
"ultraDark": "#9a4dff",
"background": {
Expand Down Expand Up @@ -91,12 +91,8 @@
"pages":[
"introduction/foundations/basic",
"introduction/foundations/components/entity/entity-guide",
"introduction/foundations/components/actions/action-guide",
"introduction/foundations/components/custom_actions",
"introduction/foundations/components/triggers/trigger-guide",
"introduction/foundations/components/integrations/custom-integration",
"introduction/foundations/components/integrations/integration-guide",
"introduction/foundations/components/actions/processing",
"introduction/foundations/components/workspace",
"introduction/foundations/components/list_local_tools"
]
Expand All @@ -112,17 +108,6 @@
"patterns/Auth/examples/shopify_example"
]
},
{
"group":"Actions",
"icon":"shuttle-space" ,
"pages":[
"patterns/actions/action-guide-with-agents",
"patterns/actions/action-guide-without-agents",
"patterns/actions/custom_actions",
"patterns/actions/usecase",
"patterns/actions/action-guide-faqs"
]
},
{
"group": "Triggers",
"icon":"bolt",
Expand All @@ -145,6 +130,33 @@
}
]
},
{
"group": "Tools",
"pages": [
"patterns/tools/what-are-tools",
{
"group": "Use Tools",
"icon": "shuttle-space",
"pages": [
"patterns/tools/use-tools/action-guide-with-agents",
"patterns/tools/use-tools/use-specific-actions",
"patterns/tools/use-tools/get-action-inputs",
"patterns/tools/use-tools/processing-actions",
"patterns/tools/use-tools/configure-tools",
"patterns/tools/use-tools/action-guide-without-agents"
]
},
{
"group": "Build Tools",
"icon": "hammer",
"pages": [
"patterns/tools/build-tools/custom-action-for-new-tool",
"patterns/tools/build-tools/custom-action-for-existing-tool"
]
},
"patterns/tools/custom-integration"
]
},
{
"group":"Supported Frameworks",
"pages":[
Expand Down Expand Up @@ -175,7 +187,7 @@
]
},
{
"group": "SweKit",
"group": "SWE Kit",
"pages": [
"swekit-tools/introduction",
"swekit-js/introduction",
Expand Down
Loading

0 comments on commit faa547b

Please sign in to comment.