@@ -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