Skip to content

Commit 02a1757

Browse files
committed
fixed broken links
1 parent 0dab6c6 commit 02a1757

24 files changed

+180
-42
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: Architecture Overview
4+
---
5+
6+
# Agent Architecture Overview
7+
8+
This section covers the detailed architecture of Codebolt agents.
9+
10+
## Coming Soon
11+
12+
Detailed architecture documentation is being developed. For now, please refer to the [Agent Introduction](../agentIntroduction.md) for basic concepts.
13+
14+
## Key Components
15+
16+
- Agent Runtime Environment
17+
- Communication Protocols
18+
- Tool Integration
19+
- State Management
20+
21+
For immediate help, see the [QuickStart Guide](../quickstart.md).
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: Agent Architecture
4+
---
5+
6+
# Agent Architecture
7+
8+
This section covers the detailed architecture and concepts behind Codebolt agents.
9+
10+
## Architecture Overview
11+
12+
Learn about the core components and design patterns that make Codebolt agents powerful and flexible.
13+
14+
## Available Topics
15+
16+
- [Architecture Overview](./1_architecture.md) - Core architectural concepts
17+
18+
## Coming Soon
19+
20+
More detailed architecture documentation is being developed. For immediate help:
21+
22+
- [Agent Introduction](../agentIntroduction.md) - Basic concepts and overview
23+
- [QuickStart Guide](../quickstart.md) - Get started quickly
24+
- [Custom Agents](../3_customagents/3_firstExtension.md) - Build your own agents
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: Using Agents
4+
---
5+
6+
# Using Agents
7+
8+
This section covers how to effectively use Codebolt agents in your development workflow.
9+
10+
## Available Topics
11+
12+
- [Running Agents](./5_runAgent.md) - How to run and manage agents
13+
14+
## Coming Soon
15+
16+
More documentation on using agents effectively is being developed. For immediate help:
17+
18+
- [Agent Introduction](../agentIntroduction.md) - Basic concepts and overview
19+
- [QuickStart Guide](../quickstart.md) - Get started quickly
20+
- [Custom Agents](../3_customagents/3_firstExtension.md) - Build your own agents
21+
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: Custom Agents
4+
---
5+
6+
# Custom Agents
7+
8+
This section covers how to build and customize your own Codebolt agents.
9+
10+
## Available Topics
11+
12+
- [First Extension](./3_firstExtension.md) - Create your first custom agent
13+
- [Run Extension](./4_runExtension.md) - Running and testing your agent
14+
- [Publish Extension](./6_publishExtension.md) - Publishing your agent
15+
16+
## Getting Started
17+
18+
Building custom agents allows you to create specialized AI assistants for your specific development needs.
19+
20+
## Next Steps
21+
22+
For more information:
23+
24+
- [Agent Introduction](../agentIntroduction.md) - Basic concepts and overview
25+
- [QuickStart Guide](../quickstart.md) - Get started quickly
26+
- [Agent Architecture](../1_agentarchitecture/1_architecture.md) - Understand the technical details

docs/developer/agents/agentIntroduction.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -209,8 +209,8 @@ Ready to create your first agent? Here's what you need:
209209

210210
1. **Prerequisites**: Node.js, Codebolt CLI, and basic JavaScript knowledge
211211
2. **Quick Start**: Follow our [QuickStart Guide](./quickstart.md) for a 10-minute setup
212-
3. **Deep Dive**: Explore [Agent Architecture](./1_agentarchitecture.md) for detailed concepts
213-
4. **Examples**: Check out [Custom Agents](./3_customagents.md) for real-world examples
212+
3. **Deep Dive**: Explore [Agent Architecture](./1_agentarchitecture/1_architecture.md) for detailed concepts
213+
4. **Examples**: Check out [Custom Agents](./3_customagents/3_firstExtension.md) for real-world examples
214214

215215
## Agent Ecosystem
216216

@@ -224,9 +224,9 @@ The Codebolt agent ecosystem includes:
224224
## Next Steps
225225

226226
- **[QuickStart Guide](./quickstart.md)** - Create your first agent in 10 minutes
227-
- **[Agent Architecture](./1_agentarchitecture.md)** - Understand the technical details
228-
- **[Using Agents](./2_usingagents.md)** - Learn how to effectively use agents
229-
- **[Custom Agents](./3_customagents.md)** - Build specialized agents for your needs
227+
- **[Agent Architecture](./1_agentarchitecture/1_architecture.md)** - Understand the technical details
228+
- **[Using Agents](./2_usingagents/5_runAgent.md)** - Learn how to effectively use agents
229+
- **[Custom Agents](./3_customagents/3_firstExtension.md)** - Build specialized agents for your needs
230230

231231
---
232232

docs/developer/agents/multi-agent.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
sidebar_position: 5
3+
sidebar_label: Multi-Agent Systems
4+
---
5+
6+
# Multi-Agent Systems
7+
8+
This section covers how multiple Codebolt agents can work together.
9+
10+
## Coming Soon
11+
12+
Multi-agent system documentation is being developed.
13+
14+
## Overview
15+
16+
- Agent Coordination
17+
- Inter-Agent Communication
18+
- Workflow Orchestration
19+
- Shared Resources
20+
21+
For current agent development, see the [Agent Introduction](./agentIntroduction.md).

docs/developer/agents/quickstart.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: QuickStart
55

66
# QuickStart
77

8-
This guide will walk you through creating your first Codebolt agent in under 10 minutes. For detailed explanations, see the [complete documentation](./1_agentarchitecture.md).
8+
This guide will walk you through creating your first Codebolt agent in under 10 minutes. For detailed explanations, see the [complete documentation](./1_agentarchitecture/1_architecture.md).
99

1010
## Prerequisites
1111

@@ -283,9 +283,9 @@ try {
283283

284284
Now that you've created your first agent, explore:
285285

286-
- **[Agent Architecture](./1_agentarchitecture.md)** - Deep dive into agent concepts
287-
- **[Using Agents](./2_usingagents.md)** - Advanced usage patterns
288-
- **[Custom Agents](./3_customagents.md)** - Building specialized agents
286+
- **[Agent Architecture](./1_agentarchitecture/1_architecture.md)** - Deep dive into agent concepts
287+
- **[Using Agents](./2_usingagents/5_runAgent.md)** - Advanced usage patterns
288+
- **[Custom Agents](./3_customagents/3_firstExtension.md)** - Building specialized agents
289289
- **[Tools Integration](../tools/quickstart.md)** - Add tools to your agents
290290

291291
## Troubleshooting

docs/developer/cli/agents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -485,4 +485,4 @@ metadata:
485485
- [Learn about tool development](./tools.md)
486486
- [Explore the complete command reference](./commands.md)
487487
- [See practical examples](./examples.md)
488-
- [Understand the agent SDK](../agents/)
488+
- [Understand the agent SDK](../agents/agentIntroduction.md)

docs/developer/cli/authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,6 @@ The authentication system integrates with the Codebolt API:
220220
After successful authentication:
221221

222222
1. [Create your first agent](./agents.md)
223-
2. [Explore agent management](./agents.md#agent-lifecycle)
223+
2. [Explore agent management](./agents.md#agent-lifecycle-management)
224224
3. [Learn about tool development](./tools.md)
225225
4. [Review all available commands](./commands.md)

docs/developer/cli/tools.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Codebolt Tools are MCP-compatible utilities that:
1616
- **Support Parameters**: Accept configuration and runtime parameters
1717
- **Are Testable**: Can be debugged and tested independently
1818

19-
For detailed information about tool architecture and development concepts, see the [Tools Documentation](../../tools/).
19+
For detailed information about tool architecture and development concepts, see the [Tools Documentation](../tools/).
2020

2121
## CLI Commands for Tools
2222

@@ -322,7 +322,7 @@ codebolt-cli runtool query ./.codeboltAgents/tools/database-tool/index.js
322322

323323
## Next Steps
324324

325-
- [Learn about detailed tool development](../../tools/)
325+
- [Learn about detailed tool development](../tools/)
326326
- [Explore MCP protocol documentation](https://modelcontextprotocol.io/)
327327
- [See agent integration examples](./agents.md)
328328
- [Review complete command reference](./commands.md)

docs/developer/templates/best-practices.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -801,8 +801,8 @@ updateVersion(type)
801801
## Next Steps
802802

803803
- **[Template Examples](./examples.md)** - Study real-world template implementations
804-
- **[Community Guidelines](./community.md)** - Understand community standards
805-
- **[Advanced Patterns](./advanced-patterns.md)** - Learn sophisticated template techniques
804+
- **[Publishing Templates](./publishing.md)** - Understand community standards
805+
- **[Template Configuration](./configuration.md)** - Learn sophisticated template techniques
806806

807807
---
808808

docs/developer/templates/creating-templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ docker run -p 3000:3000 my-awesome-app
359359

360360
## License
361361

362-
MIT License - see [LICENSE](LICENSE) file for details.
362+
MIT License - see LICENSE file for details.
363363
```
364364
365365
### 4. Environment Configuration

docs/developer/templates/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1088,7 +1088,7 @@ export const ProductCard = ({ product }: ProductCardProps) => {
10881088

10891089
- **[Template Best Practices](./best-practices.md)** - Learn advanced template patterns
10901090
- **[Publishing Templates](./publishing.md)** - Share your customized templates
1091-
- **[Community Guidelines](./community.md)** - Contribute to the template ecosystem
1091+
- **[Publishing Templates](./publishing.md)** - Contribute to the template ecosystem
10921092

10931093
---
10941094

docs/developer/templates/publishing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ After publishing your template:
412412

413413
1. **[Template Best Practices](./best-practices.md)** - Learn advanced template patterns
414414
2. **[Template Examples](./examples.md)** - Study successful template implementations
415-
3. **[Community Guidelines](./community.md)** - Understand community standards
415+
3. **[Best Practices](./best-practices.md)** - Understand community standards
416416

417417
---
418418

docs/developer/tools/create_tool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -613,4 +613,4 @@ parameters:
613613
- [Test Your Tool Locally](./testlocalmcp.md) - Learn advanced testing techniques
614614
- [Publish Your Tool](./publish_tool.md) - Share your tool with the community
615615
- [Tool Registry](./tool_registry.md) - Discover and use existing tools
616-
- [Advanced Patterns](./advanced_patterns.md) - Learn advanced tool development patterns
616+
- [Advanced Patterns](./examples.md) - Learn advanced tool development patterns

docs/developer/tools/index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: Tools Overview
4+
---
5+
6+
# Tools Overview
7+
8+
This section covers Codebolt tools development and usage.
9+
10+
## Available Topics
11+
12+
- [Overview](./overview.md) - Introduction to Codebolt tools
13+
- [QuickStart](./quickstart.md) - Get started quickly with tools
14+
- [Create Tool](./create_tool.md) - How to create custom tools
15+
- [Test Local MCP](./testlocalmcp.md) - Testing tools locally
16+
- [Publish Tool](./publish_tool.md) - Publishing your tools
17+
- [Tool Registry](./tool_registry.md) - Managing tools in the registry
18+
- [Examples](./examples.md) - Practical examples
19+
- [Troubleshoot](./troubleshoot.md) - Common issues and solutions
20+
21+
## Getting Started
22+
23+
Tools extend the capabilities of Codebolt agents and provide specialized functionality.
24+
25+
Start with the [QuickStart Guide](./quickstart.md) to create your first tool.

docs/developer/tools/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -531,9 +531,9 @@ DEBUG=codebolt:tools codebolt-cli runtool function_name ./tool/index.js
531531

532532
## Next Steps
533533

534-
- [Create Your First Tool](./2_create_tool.md) - Step-by-step tool creation
535-
- [Test Tools Locally](./3_testlocalmcp.md) - Testing and debugging
536-
- [Publish Tools](./4_publish_tool.md) - Share your tools
534+
- [Create Your First Tool](./create_tool.md) - Step-by-step tool creation
535+
- [Test Tools Locally](./testlocalmcp.md) - Testing and debugging
536+
- [Publish Tools](./publish_tool.md) - Share your tools
537537
- [CLI Tool Commands](../cli/tools.md) - CLI reference
538538

539539

docs/developer/tools/publish_tool.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Once you've created and tested your tool, you can publish it to the Codebolt Too
1010
Before publishing your tool, ensure you have:
1111

1212
- **Completed Tool**: A fully functional tool with proper configuration
13-
- **Testing**: Comprehensive testing completed (see [Testing Guide](./3_testlocalmcp.md))
13+
- **Testing**: Comprehensive testing completed (see [Testing Guide](./testlocalmcp.md))
1414
- **Documentation**: Clear README and usage examples
1515
- **CLI Access**: Codebolt CLI installed and authenticated
1616
- **Account**: Valid Codebolt account with publishing permissions
@@ -595,14 +595,14 @@ Ensure your tool complies with licenses:
595595
596596
After publishing your tool:
597597
598-
- [Monitor Usage](./5_tool_registry.md) - Track your tool's performance
599-
- [Community Engagement](./6_community.md) - Engage with users
600-
- [Advanced Patterns](./7_advanced_patterns.md) - Learn advanced techniques
601-
- [Maintenance Guide](./8_maintenance.md) - Keep your tool updated
598+
- [Monitor Usage](./tool_registry.md) - Track your tool's performance
599+
- [Community Engagement](./examples.md) - Engage with users
600+
- [Advanced Patterns](./examples.md) - Learn advanced techniques
601+
- [Maintenance Guide](./troubleshoot.md) - Keep your tool updated
602602
603603
## Support and Resources
604604
605-
- **Documentation**: [Tool Registry Guide](./5_tool_registry.md)
605+
- **Documentation**: [Tool Registry Guide](./tool_registry.md)
606606
- **Community**: [Codebolt Discord](https://discord.gg/codebolt)
607607
- **Issues**: [GitHub Issues](https://github.com/codebolt/tools/issues)
608608
- **Email**: [email protected]

docs/developer/tools/quickstart.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Quickstart
55

66
# Quickstart
77

8-
This guide will walk you through creating your first Codebolt tool in under 10 minutes. For detailed explanations, see the [complete documentation](./tools.md).
8+
This guide will walk you through creating your first Codebolt tool in under 10 minutes. For detailed explanations, see the [complete documentation](./overview.md).
99

1010
## Prerequisites
1111

@@ -35,7 +35,7 @@ cd .codeboltAgents/tools/hello-world-tool
3535

3636
## Step 2: Configure Your Tool
3737

38-
The tool details are written in [`codebolttool.yaml`](`codebolttool.yaml`). Edit `codebolttool.yaml`:
38+
The tool details are written in `codebolttool.yaml`. Edit `codebolttool.yaml`:
3939

4040
```yaml
4141
name: "Hello World Tool"
@@ -52,7 +52,7 @@ parameters:
5252
5353
## Step 3: Implement Tool Logic
5454
55-
The Tool Logic is written using [ToolBox class](./tools.md#toolbox-class). Replace `index.js` content:
55+
The Tool Logic is written using [ToolBox class](./overview.md#tool-implementation-patterns). Replace `index.js` content:
5656

5757
```javascript
5858
const { ToolBox } = require('@codebolt/toolbox');
@@ -122,7 +122,7 @@ npx codebolt-cli inspecttool ./index.js
122122
## Step 5: Test Your Tool in Codebolt Application
123123

124124
- Open the Codebolt Application and open the current project.
125-
- Make Sure the [Tool is enabled for the Current Agent](../cli/agents.md#enable-tool).
125+
- Make Sure the Tool is enabled for the Current Agent (see [Agent Configuration](../cli/agents.md#agent-configuration)).
126126
- In the Chat, ask the AI Agent with the following message:
127127
```
128128
User: Ask Greet Hello World tool to greet Alex.
@@ -187,7 +187,7 @@ npx codebolt-cli updatetool <tool-name> # Update tool
187187

188188
Now that you've created your first tool, explore:
189189

190-
- **[Complete Tools Guide](./tools.md)** - Detailed concepts and patterns
190+
- **[Complete Tools Guide](./overview.md)** - Detailed concepts and patterns
191191
- **[Testing Guide](./testlocalmcp.md)** - Comprehensive testing strategies
192192
- **[Publishing Guide](./publish_tool.md)** - Advanced publishing features
193193
- **[Tool Registry](./tool_registry.md)** - Discover and manage tools

docs/developer/tools/testlocalmcp.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -775,9 +775,9 @@ parameters:
775775
776776
## Next Steps
777777
778-
- [Publish Your Tool](./4_publish_tool.md) - Share your tested tool
779-
- [Tool Registry](./5_tool_registry.md) - Discover existing tools
780-
- [Advanced Patterns](./6_advanced_patterns.md) - Learn advanced techniques
778+
- [Publish Your Tool](./publish_tool.md) - Share your tested tool
779+
- [Tool Registry](./tool_registry.md) - Discover existing tools
780+
- [Advanced Patterns](./examples.md) - Learn advanced techniques
781781
- [CLI Reference](../cli/tools.md) - Complete CLI documentation
782782
783783

docs/developer/tools/tool_registry.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -572,7 +572,7 @@ codebolt-cli registry authors --top
572572

573573
## Next Steps
574574

575-
- [Create Your Own Tool](./2_create_tool.md) - Build and share tools
576-
- [Advanced Tool Patterns](./6_advanced_patterns.md) - Learn advanced techniques
575+
- [Create Your Own Tool](./create_tool.md) - Build and share tools
576+
- [Advanced Tool Patterns](./examples.md) - Learn advanced techniques
577577
- [CLI Reference](../cli/tools.md) - Complete CLI documentation
578-
- [Community Guidelines](./7_community.md) - Engage with the community
578+
- [Community Guidelines](./examples.md) - Engage with the community

docs/developer/typescriptSdk/agent-framework.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -697,7 +697,7 @@ const agent = taskComplexity === 'simple'
697697

698698
- **[API Reference](./api-reference.md)** - Complete function documentation
699699
- **[Examples](./examples.md)** - Real-world agent implementations
700-
- **[Best Practices](./best-practices.md)** - Advanced patterns and optimization
700+
- **[Examples](./examples.md)** - Advanced patterns and optimization
701701

702702
---
703703

0 commit comments

Comments
 (0)