Skip to content

Commit 2b7f710

Browse files
GeneAIclaude
authored andcommitted
fix: Update internal links for Diátaxis reorganization
Fix broken documentation links after restructuring: - api-reference/ → reference/ - getting-started/ → tutorials/ - examples/ → tutorials/examples/ - Fix double path issues (tutorials/tutorials/) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent fc16091 commit 2b7f710

22 files changed

+55
-51
lines changed

docs/explanation/adaptive-learning.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -413,13 +413,13 @@ print(f"Learning velocity: {metrics['learning_velocity']}") # How fast improvin
413413

414414
## Examples
415415

416-
See the complete [Adaptive Learning System Example](../examples/adaptive-learning-system.md) for a full implementation.
416+
See the complete [Adaptive Learning System Example](../tutorials/examples/adaptive-learning-system.md) for a full implementation.
417417

418418
---
419419

420420
## See Also
421421

422422
- [Multi-Agent Coordination](multi-agent-coordination.md) - Team patterns
423-
- [Adaptive Learning Example](../examples/adaptive-learning-system.md) - Full implementation
424-
- [Pattern Library API](../api-reference/pattern-library.md) - Pattern management
425-
- [EmpathyOS API](../api-reference/empathy-os.md) - Core configuration
423+
- [Adaptive Learning Example](../tutorials/examples/adaptive-learning-system.md) - Full implementation
424+
- [Pattern Library API](../reference/pattern-library.md) - Pattern management
425+
- [EmpathyOS API](../reference/empathy-os.md) - Core configuration

docs/explanation/multi-agent-philosophy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -492,8 +492,8 @@ session.signal("review_complete", {
492492
## Next Steps
493493

494494
- **[Short-Term Memory Reference](../SHORT_TERM_MEMORY.md)**: Complete API documentation
495-
- **[API Reference: Multi-Agent](../api-reference/multi-agent.md)**: Detailed class documentation
496-
- **[Example: Team Coordination](../examples/multi-agent-team-coordination.md)**: Full working example
495+
- **[API Reference: Multi-Agent](../reference/multi-agent.md)**: Detailed class documentation
496+
- **[Example: Team Coordination](../tutorials/examples/multi-agent-team-coordination.md)**: Full working example
497497

498498
---
499499

docs/how-to/hipaa-compliance.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -466,9 +466,9 @@ For a **100-bed hospital**:
466466
## See Also
467467

468468
- [Security Architecture](security-architecture.md) - Technical implementation details
469-
- [Healthcare Wizards](../api-reference/wizards.md) - PHI-aware AI assistants
470-
- [SBAR Example](../examples/sbar-clinical-handoff.md) - HIPAA-compliant handoff protocol
471-
- [LLM Toolkit](../api-reference/llm-toolkit.md) - Security API reference
469+
- [Healthcare Wizards](../reference/wizards.md) - PHI-aware AI assistants
470+
- [SBAR Example](../tutorials/examples/sbar-clinical-handoff.md) - HIPAA-compliant handoff protocol
471+
- [LLM Toolkit](../reference/llm-toolkit.md) - Security API reference
472472

473473
---
474474

docs/how-to/multi-agent-coordination.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -503,7 +503,7 @@ print(f"Collaboration efficiency: {team_stats['collaboration_efficiency']:.0%}")
503503

504504
## Examples
505505

506-
See the complete [Multi-Agent Team Coordination Example](../examples/multi-agent-team-coordination.md) for a full implementation with:
506+
See the complete [Multi-Agent Team Coordination Example](../tutorials/examples/multi-agent-team-coordination.md) for a full implementation with:
507507

508508
- PR review automation
509509
- Automated test generation
@@ -516,6 +516,6 @@ See the complete [Multi-Agent Team Coordination Example](../examples/multi-agent
516516
## See Also
517517

518518
- [Adaptive Learning](adaptive-learning.md) - How agents learn
519-
- [Pattern Library API](../api-reference/pattern-library.md) - Pattern management
520-
- [Multi-Agent Example](../examples/multi-agent-team-coordination.md) - Full implementation
521-
- [EmpathyOS API](../api-reference/empathy-os.md) - Agent configuration
519+
- [Pattern Library API](../reference/pattern-library.md) - Pattern management
520+
- [Multi-Agent Example](../tutorials/examples/multi-agent-team-coordination.md) - Full implementation
521+
- [EmpathyOS API](../reference/empathy-os.md) - Agent configuration

docs/how-to/practical-patterns.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -679,8 +679,8 @@ print(f"After 12 successes: {status['current_tier']}")
679679

680680
## Next Steps
681681

682-
- **[API Reference](../api-reference/multi-agent.md)**: Full class documentation
683-
- **[Examples](../examples/multi-agent-team-coordination.md)**: Complete working examples
682+
- **[API Reference](../reference/multi-agent.md)**: Full class documentation
683+
- **[Examples](../tutorials/examples/multi-agent-team-coordination.md)**: Complete working examples
684684
- **[Philosophy](./multi-agent-philosophy.md)**: Understand the design principles
685685

686686
---

docs/how-to/security-architecture.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,6 @@ def test_secrets_detection():
370370
## See Also
371371

372372
- [HIPAA Compliance Guide](hipaa-compliance.md) - Healthcare-specific requirements
373-
- [LLM Toolkit API](../api-reference/llm-toolkit.md) - Security API reference
374-
- [Industry Wizards](../api-reference/wizards.md) - Domain-specific security
375-
- [SBAR Example](../examples/sbar-clinical-handoff.md) - Healthcare security in action
373+
- [LLM Toolkit API](../reference/llm-toolkit.md) - Security API reference
374+
- [Industry Wizards](../reference/wizards.md) - Domain-specific security
375+
- [SBAR Example](../tutorials/examples/sbar-clinical-handoff.md) - Healthcare security in action

docs/how-to/short-term-memory-implementation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -543,8 +543,8 @@ new_agent.restore_collaboration_state(session_id=agent.session_id)
543543
## Next Steps
544544

545545
- **[Practical Patterns](./practical-patterns.md)**: Ready-to-use patterns for common scenarios
546-
- **[API Reference](../api-reference/multi-agent.md)**: Complete class documentation
547-
- **[Examples](../examples/multi-agent-team-coordination.md)**: Full working examples
546+
- **[API Reference](../reference/multi-agent.md)**: Complete class documentation
547+
- **[Examples](../tutorials/examples/multi-agent-team-coordination.md)**: Full working examples
548548

549549
---
550550

docs/how-to/unified-memory-system.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,7 @@ from empathy_os.memory.security import AuditLogger
444444

445445
- **[Short-Term Memory Implementation](./short-term-memory-implementation.md)**: Detailed Redis setup
446446
- **[Security Architecture](./security-architecture.md)**: PII scrubbing, encryption, audit logging
447-
- **[API Reference: Memory](../api-reference/multi-agent.md)**: Complete class documentation
447+
- **[API Reference: Memory](../reference/multi-agent.md)**: Complete class documentation
448448

449449
---
450450

docs/how-to/webhook-integration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -556,7 +556,7 @@ print(f"Failed deliveries: {stats['failed_count']}")
556556

557557
## Examples
558558

559-
See the complete [Webhook Event Integration Example](../examples/webhook-event-integration.md) for implementations with:
559+
See the complete [Webhook Event Integration Example](../tutorials/examples/webhook-event-integration.md) for implementations with:
560560

561561
- Slack notifications
562562
- JIRA ticket creation
@@ -568,6 +568,6 @@ See the complete [Webhook Event Integration Example](../examples/webhook-event-i
568568

569569
## See Also
570570

571-
- [Webhook Example](../examples/webhook-event-integration.md) - Full implementation
571+
- [Webhook Example](../tutorials/examples/webhook-event-integration.md) - Full implementation
572572
- [Security Architecture](security-architecture.md) - Webhook security
573-
- [EmpathyOS API](../api-reference/empathy-os.md) - Webhook configuration
573+
- [EmpathyOS API](../reference/empathy-os.md) - Webhook configuration

docs/index.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Webhooks for Slack, GitHub, JIRA, Datadog, and custom services.
102102

103103
**Patient Handoffs**: Automated SBAR reports (60% time savings)
104104

105-
**Live demo coming soon** - See the [SBAR Example](examples/sbar-clinical-handoff.md) for complete code
105+
**Live demo coming soon** - See the [SBAR Example](tutorials/examples/sbar-clinical-handoff.md) for complete code
106106

107107
```python
108108
from empathy_os import EmpathyOS
@@ -148,10 +148,14 @@ Webhooks for Slack, GitHub, JIRA, Datadog, and custom services.
148148

149149
## Documentation
150150

151-
- **[Getting Started](getting-started/installation.md)**: Install and configure
152-
- **[Examples](examples/simple-chatbot.md)**: 5 comprehensive tutorials
153-
- **[API Reference](api-reference/index.md)**: Complete API documentation
154-
- **[Contributing](contributing.md)**: How to contribute
151+
Organized using the [Diátaxis framework](https://diataxis.fr/) for better discoverability:
152+
153+
| Section | Purpose | Start Here |
154+
|---------|---------|------------|
155+
| **[Tutorials](tutorials/index.md)** | Learn by doing | [Quick Start](tutorials/quickstart.md) |
156+
| **[How-to](how-to/index.md)** | Solve specific tasks | [Agent Factory](how-to/agent-factory.md) |
157+
| **[Explanation](explanation/index.md)** | Understand concepts | [Philosophy](explanation/EMPATHY_PHILOSOPHY.md) |
158+
| **[Reference](reference/index.md)** | Look up details | [API Reference](reference/API_REFERENCE.md) |
155159

156160
---
157161

@@ -190,31 +194,31 @@ Webhooks for Slack, GitHub, JIRA, Datadog, and custom services.
190194

191195
Get up and running in 5 minutes
192196

193-
[:octicons-arrow-right-24: Quick Start](getting-started/quickstart.md)
197+
[:octicons-arrow-right-24: Quick Start](tutorials/quickstart.md)
194198

195199
- :fontawesome-solid-robot:{ .lg .middle } **Examples**
196200

197201
---
198202

199203
5 comprehensive tutorials with working code
200204

201-
[:octicons-arrow-right-24: See Examples](examples/simple-chatbot.md)
205+
[:octicons-arrow-right-24: See Examples](tutorials/examples/simple-chatbot.md)
202206

203207
- :fontawesome-solid-hospital:{ .lg .middle } **Healthcare**
204208

205209
---
206210

207211
HIPAA-compliant, $2M+ ROI
208212

209-
[:octicons-arrow-right-24: SBAR Example](examples/sbar-clinical-handoff.md)
213+
[:octicons-arrow-right-24: SBAR Example](tutorials/examples/sbar-clinical-handoff.md)
210214

211215
- :material-book-open-variant:{ .lg .middle } **API Reference**
212216

213217
---
214218

215219
Complete API documentation
216220

217-
[:octicons-arrow-right-24: API Docs](api-reference/index.md)
221+
[:octicons-arrow-right-24: API Docs](reference/index.md)
218222

219223
</div>
220224

0 commit comments

Comments
 (0)