Skip to content

Commit ffd717c

Browse files
fix: custom tool docs links, add mintlify broken links action (#3903)
* fix: update docs links to point to correct endpoints * fix: update all broken doc links
1 parent fbe4aa4 commit ffd717c

File tree

31 files changed

+77
-48
lines changed

31 files changed

+77
-48
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Check Documentation Broken Links
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- "docs/**"
7+
- "docs.json"
8+
push:
9+
branches:
10+
- main
11+
paths:
12+
- "docs/**"
13+
- "docs.json"
14+
workflow_dispatch:
15+
16+
jobs:
17+
check-links:
18+
name: Check broken links
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
23+
- name: Set up Node
24+
uses: actions/setup-node@v4
25+
with:
26+
node-version: "latest"
27+
28+
- name: Install Mintlify CLI
29+
run: npm i -g mintlify
30+
31+
- name: Run broken link checker
32+
run: |
33+
# Auto-answer the prompt with yes command
34+
yes "" | mintlify broken-links || test $? -eq 141
35+
working-directory: ./docs

docs/en/concepts/knowledge.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -739,7 +739,7 @@ class KnowledgeMonitorListener(BaseEventListener):
739739
knowledge_monitor = KnowledgeMonitorListener()
740740
```
741741

742-
For more information on using events, see the [Event Listeners](https://docs.crewai.com/concepts/event-listener) documentation.
742+
For more information on using events, see the [Event Listeners](/en/concepts/event-listener) documentation.
743743

744744
### Custom Knowledge Sources
745745

docs/en/concepts/llms.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1035,7 +1035,7 @@ CrewAI supports streaming responses from LLMs, allowing your application to rece
10351035
```
10361036

10371037
<Tip>
1038-
[Click here](https://docs.crewai.com/concepts/event-listener#event-listeners) for more details
1038+
[Click here](/en/concepts/event-listener#event-listeners) for more details
10391039
</Tip>
10401040
</Tab>
10411041

docs/en/enterprise/features/marketplace.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ you can use them locally or refine them to your needs.
3737
<Card title="Tools & Integrations" href="/en/enterprise/features/tools-and-integrations" icon="wrench">
3838
Connect external apps and manage internal tools your agents can use.
3939
</Card>
40-
<Card title="Tool Repository" href="/en/enterprise/features/tool-repository" icon="toolbox">
40+
<Card title="Tool Repository" href="/en/enterprise/guides/tool-repository#tool-repository" icon="toolbox">
4141
Publish and install tools to enhance your crews' capabilities.
4242
</Card>
4343
<Card title="Agents Repository" href="/en/enterprise/features/agent-repositories" icon="people-group">

docs/en/enterprise/features/tools-and-integrations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ Tools & Integrations is the central hub for connecting third‑party apps and ma
241241
## Related
242242

243243
<CardGroup cols={2}>
244-
<Card title="Tool Repository" href="/en/enterprise/features/tool-repository" icon="toolbox">
244+
<Card title="Tool Repository" href="/en/enterprise/guides/tool-repository#tool-repository" icon="toolbox">
245245
Create, publish, and version custom tools for your organization.
246246
</Card>
247247
<Card title="Webhook Automation" href="/en/enterprise/guides/webhook-automation" icon="bolt">

docs/en/enterprise/guides/tool-repository.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The repository is not a version control system. Use Git to track code changes an
2121
Before using the Tool Repository, ensure you have:
2222

2323
- A [CrewAI AMP](https://app.crewai.com) account
24-
- [CrewAI CLI](https://docs.crewai.com/concepts/cli#cli) installed
24+
- [CrewAI CLI](/en/concepts/cli#cli) installed
2525
- uv>=0.5.0 installed. Check out [how to upgrade](https://docs.astral.sh/uv/getting-started/installation/#upgrading-uv)
2626
- [Git](https://git-scm.com) installed and configured
2727
- Access permissions to publish or install tools in your CrewAI AMP organization
@@ -112,7 +112,7 @@ By default, tools are published as private. To make a tool public:
112112
crewai tool publish --public
113113
```
114114

115-
For more details on how to build tools, see [Creating your own tools](https://docs.crewai.com/concepts/tools#creating-your-own-tools).
115+
For more details on how to build tools, see [Creating your own tools](/en/concepts/tools#creating-your-own-tools).
116116

117117
## Updating Tools
118118

docs/en/enterprise/resources/frequently-asked-questions.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ mode: "wide"
4949

5050
To integrate human input into agent execution, set the `human_input` flag in the task definition. When enabled, the agent prompts the user for input before delivering its final answer. This input can provide extra context, clarify ambiguities, or validate the agent's output.
5151

52-
For detailed implementation guidance, see our [Human-in-the-Loop guide](/en/how-to/human-in-the-loop).
52+
For detailed implementation guidance, see our [Human-in-the-Loop guide](/en/enterprise/guides/human-in-the-loop).
5353
</Accordion>
5454

5555
<Accordion title="What advanced customization options are available for tailoring and enhancing agent behavior and capabilities in CrewAI?">
@@ -142,7 +142,7 @@ mode: "wide"
142142
<Accordion title="How can I create custom tools for my CrewAI agents?">
143143
You can create custom tools by subclassing the `BaseTool` class provided by CrewAI or by using the tool decorator. Subclassing involves defining a new class that inherits from `BaseTool`, specifying the name, description, and the `_run` method for operational logic. The tool decorator allows you to create a `Tool` object directly with the required attributes and a functional logic.
144144

145-
<Card href="https://docs.crewai.com/how-to/create-custom-tools" icon="code">CrewAI Tools Guide</Card>
145+
<Card href="/en/learn/create-custom-tools" icon="code">CrewAI Tools Guide</Card>
146146
</Accordion>
147147

148148
<Accordion title="How can you control the maximum number of requests per minute that the entire crew can perform?">

docs/en/learn/hierarchical-process.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ project_crew = Crew(
9797
```
9898

9999
<Tip>
100-
For more details on creating and customizing a manager agent, check out the [Custom Manager Agent documentation](https://docs.crewai.com/how-to/custom-manager-agent#custom-manager-agent).
100+
For more details on creating and customizing a manager agent, check out the [Custom Manager Agent documentation](/en/learn/custom-manager-agent).
101101
</Tip>
102102

103103

docs/en/observability/portkey.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -733,9 +733,7 @@ Here's a basic configuration to route requests to OpenAI, specifically using GPT
733733
- Collect relevant metadata to filter logs
734734
- Enforce access permissions
735735

736-
Create API keys through:
737-
- [Portkey App](https://app.portkey.ai/)
738-
- [API Key Management API](/en/api-reference/admin-api/control-plane/api-keys/create-api-key)
736+
Create API keys through the [Portkey App](https://app.portkey.ai/)
739737

740738
Example using Python SDK:
741739
```python
@@ -758,7 +756,7 @@ Here's a basic configuration to route requests to OpenAI, specifically using GPT
758756
)
759757
```
760758

761-
For detailed key management instructions, see our [API Keys documentation](/en/api-reference/admin-api/control-plane/api-keys/create-api-key).
759+
For detailed key management instructions, see the [Portkey documentation](https://portkey.ai/docs).
762760
</Accordion>
763761

764762
<Accordion title="Step 4: Deploy & Monitor">

docs/en/tools/cloud-storage/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ These tools enable your agents to interact with cloud services, access cloud sto
1818
Write and upload files to Amazon S3 storage.
1919
</Card>
2020

21-
<Card title="Bedrock Invoke Agent" icon="aws" href="/en/tools/cloud-storage/bedrockinvokeagenttool">
21+
<Card title="Bedrock Invoke Agent" icon="aws" href="/en/tools/integration/bedrockinvokeagenttool">
2222
Invoke Amazon Bedrock agents for AI-powered tasks.
2323
</Card>
2424

0 commit comments

Comments
 (0)