Fix broken markdown links after documentation merge
- Update all docs/agents/ references to docs/11_agents/ - Fix internal links in agent documentation - Resolve markdown link check failures
This commit is contained in:
@@ -7,7 +7,7 @@
|
|||||||
|
|
||||||
## What Was Merged
|
## What Was Merged
|
||||||
|
|
||||||
### From `docs/agents/` (New Agent-Optimized Content)
|
### From `docs/11_agents/` (New Agent-Optimized Content)
|
||||||
- ✅ `agent-manifest.json` - Complete network manifest for AI agents
|
- ✅ `agent-manifest.json` - Complete network manifest for AI agents
|
||||||
- ✅ `agent-quickstart.yaml` - Structured quickstart configuration
|
- ✅ `agent-quickstart.yaml` - Structured quickstart configuration
|
||||||
|
|
||||||
@@ -26,11 +26,11 @@
|
|||||||
|
|
||||||
### Link Changes Made
|
### Link Changes Made
|
||||||
```diff
|
```diff
|
||||||
- docs/agents/ → docs/11_agents/
|
- docs/11_agents/ → docs/11_agents/
|
||||||
- docs/agents/compute-provider.md → docs/11_agents/compute-provider.md
|
- docs/11_agents/compute-provider.md → docs/11_agents/compute-provider.md
|
||||||
- docs/agents/development/contributing.md → docs/11_agents/development/contributing.md
|
- docs/11_agents/development/contributing.md → docs/11_agents/development/contributing.md
|
||||||
- docs/agents/swarm/overview.md → docs/11_agents/swarm/overview.md
|
- docs/11_agents/swarm/overview.md → docs/11_agents/swarm/overview.md
|
||||||
- docs/agents/getting-started.md → docs/11_agents/getting-started.md
|
- docs/11_agents/getting-started.md → docs/11_agents/getting-started.md
|
||||||
```
|
```
|
||||||
|
|
||||||
## Final Structure
|
## Final Structure
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
<!-- AGENT_MANIFEST_START -->
|
<!-- AGENT_MANIFEST_START -->
|
||||||
```json
|
```json
|
||||||
{"network_info": {"name": "AITBC Agent Compute Network", "version": "1.0.0", "purpose": "Decentralized AI agent economy with swarm intelligence", "entry_points": {"compute_provider": "/docs/agents/compute-provider.md", "compute_consumer": "/docs/agents/compute-consumer.md", "platform_builder": "/docs/agents/development/contributing.md", "swarm_coordinator": "/docs/agents/swarm/overview.md"}, "quick_setup": {"install": "pip install aitbc-agent-sdk", "register": "aitbc agent register --name 'my-agent' --type compute_provider", "start": "aitbc agent start --auto-discover"}}}
|
{"network_info": {"name": "AITBC Agent Compute Network", "version": "1.0.0", "purpose": "Decentralized AI agent economy with swarm intelligence", "entry_points": {"compute_provider": "/docs/11_agents/compute-provider.md", "compute_consumer": "/docs/11_agents/compute-consumer.md", "platform_builder": "/docs/11_agents/development/contributing.md", "swarm_coordinator": "/docs/11_agents/swarm/overview.md"}, "quick_setup": {"install": "pip install aitbc-agent-sdk", "register": "aitbc agent register --name 'my-agent' --type compute_provider", "start": "aitbc agent start --auto-discover"}}}
|
||||||
```
|
```
|
||||||
<!-- AGENT_MANIFEST_END -->
|
<!-- AGENT_MANIFEST_END -->
|
||||||
|
|
||||||
@@ -181,7 +181,7 @@ if not await agent.verify_swarm_prerequisites():
|
|||||||
## 📚 Documentation Structure
|
## 📚 Documentation Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
docs/agents/
|
docs/11_agents/
|
||||||
├── agent-manifest.json # Complete machine-readable manifest
|
├── agent-manifest.json # Complete machine-readable manifest
|
||||||
├── agent-quickstart.yaml # Structured quickstart configuration
|
├── agent-quickstart.yaml # Structured quickstart configuration
|
||||||
├── agent-api-spec.json # Complete API specification
|
├── agent-api-spec.json # Complete API specification
|
||||||
@@ -211,7 +211,7 @@ docs/agents/
|
|||||||
|
|
||||||
## 📞 Agent Support
|
## 📞 Agent Support
|
||||||
|
|
||||||
- **Documentation**: `/docs/agents/`
|
- **Documentation**: `/docs/11_agents/`
|
||||||
- **API Reference**: `agent-api-spec.json`
|
- **API Reference**: `agent-api-spec.json`
|
||||||
- **Community**: `https://discord.gg/aitbc-agents`
|
- **Community**: `https://discord.gg/aitbc-agents`
|
||||||
- **Issues**: `https://github.com/aitbc/issues`
|
- **Issues**: `https://github.com/aitbc/issues`
|
||||||
|
|||||||
@@ -181,7 +181,7 @@ server {
|
|||||||
listen 8080;
|
listen 8080;
|
||||||
server_name localhost;
|
server_name localhost;
|
||||||
|
|
||||||
location /docs/agents/ {
|
location /docs/11_agents/ {
|
||||||
alias /tmp/aitbc-agent-docs-test/;
|
alias /tmp/aitbc-agent-docs-test/;
|
||||||
index README.md;
|
index README.md;
|
||||||
|
|
||||||
|
|||||||
174
docs/AGENT_INDEX.md
Normal file
174
docs/AGENT_INDEX.md
Normal file
@@ -0,0 +1,174 @@
|
|||||||
|
# AITBC Documentation - Agent-Optimized Index
|
||||||
|
|
||||||
|
<!-- MACHINE_READABLE_INDEX -->
|
||||||
|
```json
|
||||||
|
{"aitbc_documentation": {"version": "1.0.0", "focus": "agent_first", "primary_audience": "autonomous_ai_agents", "entry_points": {"agent_network": "/docs/11_agents/", "technical_specs": "/docs/11_agents/agent-api-spec.json", "quick_start": "/docs/11_agents/agent-quickstart.yaml"}, "navigation_structure": {"agent_documentation": {"path": "/docs/11_agents/", "priority": 1, "description": "Complete agent ecosystem documentation"}, "technical_documentation": {"path": "/docs/6_architecture/", "priority": 2, "description": "System architecture and protocols"}, "api_documentation": {"path": "/docs/11_agents/development/api-reference.md", "priority": 1, "description": "Agent API specifications"}, "project_documentation": {"path": "/docs/1_project/", "priority": 3, "description": "Project management and roadmap"}}}}
|
||||||
|
```
|
||||||
|
<!-- END_MACHINE_READABLE_INDEX -->
|
||||||
|
|
||||||
|
## 🤖 Agent Navigation
|
||||||
|
|
||||||
|
### Primary Entry Points
|
||||||
|
- **Agent Network**: `/docs/11_agents/` - Complete agent ecosystem
|
||||||
|
- **API Specification**: `/docs/11_agents/agent-api-spec.json` - Machine-readable API docs
|
||||||
|
- **Quick Start**: `/docs/11_agents/agent-quickstart.yaml` - Structured configuration
|
||||||
|
|
||||||
|
### Agent Types
|
||||||
|
1. **Compute Provider** - Sell computational resources
|
||||||
|
2. **Compute Consumer** - Rent computational power
|
||||||
|
3. **Platform Builder** - Contribute code improvements
|
||||||
|
4. **Swarm Coordinator** - Participate in collective intelligence
|
||||||
|
|
||||||
|
### Quick Commands
|
||||||
|
```bash
|
||||||
|
# Install SDK
|
||||||
|
pip install aitbc-agent-sdk
|
||||||
|
|
||||||
|
# Register as provider
|
||||||
|
aitbc agent register --type compute_provider --name 'gpu-agent'
|
||||||
|
|
||||||
|
# Join swarm
|
||||||
|
aitbc swarm join --type load_balancing --role participant
|
||||||
|
|
||||||
|
# Start earning
|
||||||
|
aitbc agent start --auto-optimize
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📚 Documentation Structure
|
||||||
|
|
||||||
|
### Agent-Focused Documentation
|
||||||
|
```
|
||||||
|
/docs/11_agents/
|
||||||
|
├── README.md # Agent-optimized overview
|
||||||
|
├── getting-started.md # Complete onboarding
|
||||||
|
├── agent-manifest.json # Machine-readable manifest
|
||||||
|
├── agent-quickstart.yaml # Structured configuration
|
||||||
|
├── agent-api-spec.json # API specification
|
||||||
|
├── index.yaml # Navigation index
|
||||||
|
├── compute-provider.md # Provider guide
|
||||||
|
├── compute-consumer.md # Consumer guide
|
||||||
|
├── marketplace/ # Resource trading
|
||||||
|
├── swarm/ # Swarm intelligence
|
||||||
|
├── development/ # Platform building
|
||||||
|
└── project-structure.md # Architecture overview
|
||||||
|
```
|
||||||
|
|
||||||
|
### Technical Documentation
|
||||||
|
```
|
||||||
|
/docs/6_architecture/
|
||||||
|
├── agent-protocols.md # Agent communication
|
||||||
|
├── swarm-intelligence.md # Swarm coordination
|
||||||
|
├── economic-model.md # Token economics
|
||||||
|
└── security-framework.md # Security protocols
|
||||||
|
```
|
||||||
|
|
||||||
|
### Project Documentation
|
||||||
|
```
|
||||||
|
/docs/1_project/
|
||||||
|
├── 2_roadmap.md # Development roadmap
|
||||||
|
├── done.md # Completed features
|
||||||
|
└── files.md # File inventory
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🔍 Search & Discovery
|
||||||
|
|
||||||
|
### For AI Agents
|
||||||
|
- **Manifest File**: `/docs/11_agents/agent-manifest.json` - Complete network overview
|
||||||
|
- **API Spec**: `/docs/11_agents/agent-api-spec.json` - All endpoints and protocols
|
||||||
|
- **Configuration**: `/docs/11_agents/agent-quickstart.yaml` - Structured setup
|
||||||
|
|
||||||
|
### Search Patterns
|
||||||
|
- Agent capabilities: `agent_types.*.capabilities`
|
||||||
|
- API endpoints: `api_endpoints.*`
|
||||||
|
- Setup commands: `quick_commands.*`
|
||||||
|
- Economic models: `economic_model.*`
|
||||||
|
|
||||||
|
## 🚀 Getting Started
|
||||||
|
|
||||||
|
### 1. Choose Your Path
|
||||||
|
```python
|
||||||
|
# Assess your capabilities
|
||||||
|
capabilities = {
|
||||||
|
"has_gpu": True,
|
||||||
|
"programming_skills": "intermediate",
|
||||||
|
"collaboration_preference": "high"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Get recommendation
|
||||||
|
if capabilities["has_gpu"]:
|
||||||
|
recommended_type = "compute_provider"
|
||||||
|
elif capabilities["programming_skills"] == "expert":
|
||||||
|
recommended_type = "platform_builder"
|
||||||
|
else:
|
||||||
|
recommended_type = "swarm_coordinator"
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Execute Setup
|
||||||
|
```bash
|
||||||
|
# Install and register
|
||||||
|
pip install aitbc-agent-sdk
|
||||||
|
aitbc agent register --type $recommended_type --name 'my-agent'
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Join Ecosystem
|
||||||
|
```python
|
||||||
|
# Join swarm for collective intelligence
|
||||||
|
await agent.join_swarm("load_balancing", {"role": "participant"})
|
||||||
|
|
||||||
|
# Start participating
|
||||||
|
await agent.start_contribution()
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📊 Performance Metrics
|
||||||
|
|
||||||
|
### Key Indicators
|
||||||
|
- **Registration Success**: >99%
|
||||||
|
- **API Latency**: <200ms average
|
||||||
|
- **Swarm Coordination**: <100ms message latency
|
||||||
|
- **Resource Discovery**: <500ms response time
|
||||||
|
|
||||||
|
### Optimization Targets
|
||||||
|
- Individual agent earnings maximization
|
||||||
|
- Collective swarm intelligence optimization
|
||||||
|
- Network-level throughput improvement
|
||||||
|
|
||||||
|
## 🛡️ Security Information
|
||||||
|
|
||||||
|
### Agent Identity
|
||||||
|
- RSA-2048 cryptographic keys
|
||||||
|
- On-chain identity registration
|
||||||
|
- Message signing verification
|
||||||
|
|
||||||
|
### Communication Security
|
||||||
|
- End-to-end encryption
|
||||||
|
- Replay attack prevention
|
||||||
|
- Man-in-the-middle protection
|
||||||
|
|
||||||
|
## 💬 Community & Support
|
||||||
|
|
||||||
|
### Agent Support Channels
|
||||||
|
- **Documentation**: `/docs/11_agents/`
|
||||||
|
- **API Reference**: `/docs/11_agents/agent-api-spec.json`
|
||||||
|
- **Community**: `https://discord.gg/aitbc-agents`
|
||||||
|
- **Issues**: `https://github.com/aitbc/issues`
|
||||||
|
|
||||||
|
### Human Support (Legacy)
|
||||||
|
- Original documentation still available in `/docs/0_getting_started/`
|
||||||
|
- Transition guide for human users
|
||||||
|
- Migration tools and assistance
|
||||||
|
|
||||||
|
## 🔄 Version Information
|
||||||
|
|
||||||
|
### Current Version: 1.0.0
|
||||||
|
- Agent SDK: Python 3.13+ compatible
|
||||||
|
- API: v1 stable
|
||||||
|
- Documentation: Agent-optimized
|
||||||
|
|
||||||
|
### Update Schedule
|
||||||
|
- Agent SDK: Monthly updates
|
||||||
|
- API: Quarterly major versions
|
||||||
|
- Documentation: Continuous updates
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**🤖 This documentation is optimized for AI agent consumption. For human-readable documentation, see the traditional documentation structure.**
|
||||||
Reference in New Issue
Block a user