|
| 1 | +# Documentation Ownership |
| 2 | + |
| 3 | +This file maps documentation sections to the repositories and plans that own the underlying behavior. Use this to identify which repo to change when fixing inaccuracies or adding features. |
| 4 | + |
| 5 | +## Ownership Legend |
| 6 | + |
| 7 | +- **workflow** → `/home/lab/workspace-hq/repos/workflow` (v2 branch) |
| 8 | +- **server** → `/home/lab/workspace-hq/repos/server` (main branch) |
| 9 | +- **cli** → `/home/lab/workspace-hq/repos/cli` (main branch) |
| 10 | +- **sdk-python** → `/home/lab/workspace-hq/repos/sdk-python` (main branch) |
| 11 | +- **waterline** → `/home/lab/workspace-hq/repos/waterline` (v2 branch) |
| 12 | +- **sample-app** → `/home/lab/workspace-hq/repos/sample-app` (main branch) |
| 13 | +- **cloud** → `/home/lab/workspace-hq/repos/cloud` (main branch) |
| 14 | + |
| 15 | +## Page-to-Repo Mapping |
| 16 | + |
| 17 | +### Getting Started |
| 18 | + |
| 19 | +| Page | Owner | Notes | |
| 20 | +|------|-------|-------| |
| 21 | +| `introduction.md` | **docs** | Overview, no code owner | |
| 22 | +| `installation.md` | **workflow** | PHP package install, Laravel integration | |
| 23 | +| `server-setup.md` | **server** | Standalone server deployment | |
| 24 | +| `cli.mdx` | **cli** | CLI installation and usage | |
| 25 | +| `how-it-works.md` | **workflow** | Engine internals, history replay, task ownership | |
| 26 | +| `migration.md` | **workflow** | v1→v2 migration guide | |
| 27 | + |
| 28 | +### Defining Workflows |
| 29 | + |
| 30 | +| Page | Owner | Notes | |
| 31 | +|------|-------|-------| |
| 32 | +| `defining-workflows/workflows.md` | **workflow** | Workflow class definition, lifecycle | |
| 33 | +| `defining-workflows/activities.md` | **workflow** | Activity definition, execution | |
| 34 | +| `defining-workflows/starting-workflows.md` | **workflow** | Start API, dispatch patterns | |
| 35 | +| `defining-workflows/workflow-id.md` | **workflow** | ID semantics, duplicate policy | |
| 36 | +| `defining-workflows/workflow-status.md` | **workflow** | Status values, lifecycle states | |
| 37 | +| `defining-workflows/passing-data.md` | **workflow** | Input, result, serialization | |
| 38 | + |
| 39 | +### Features |
| 40 | + |
| 41 | +| Page | Owner | Notes | |
| 42 | +|------|-------|-------| |
| 43 | +| `features/signals.md` | **workflow** | Signal definition, dispatch, handlers | |
| 44 | +| `features/queries.md` | **workflow** | Query definition, dispatch, handlers | |
| 45 | +| `features/timers.md` | **workflow** | Timer API, scheduling | |
| 46 | +| `features/side-effects.md` | **workflow** | Non-deterministic values | |
| 47 | +| `features/versioning.md` | **workflow** | Version markers, code evolution | |
| 48 | +| `features/child-workflows.md` | **workflow** | Parent-child orchestration | |
| 49 | +| `features/continue-as-new.md` | **workflow** | History truncation, long-running workflows | |
| 50 | +| `features/sagas.md` | **workflow** | Compensation patterns | |
| 51 | +| `features/events.md` | **workflow** | Event hooks, lifecycle listeners | |
| 52 | +| `features/heartbeats.md` | **workflow** | Activity heartbeats, progress reporting | |
| 53 | +| `features/timeouts.md` | **workflow** | Execution, run, activity timeouts | |
| 54 | +| `features/cancel-and-terminate.md` | **workflow** | Cancellation requests, forced termination | |
| 55 | +| `features/concurrency.md` | **workflow** | Parallel activities, race patterns | |
| 56 | +| `features/webhooks.md` | **workflow** | Webhook triggers | |
| 57 | +| `features/schedules.md` | **workflow** | Cron schedules, recurring workflows | |
| 58 | +| `features/search-attributes.md` | **workflow** | Searchable metadata, indexing | |
| 59 | +| `features/memo.md` | **workflow** | Workflow metadata | |
| 60 | +| `features/signal+timer.md` | **workflow** | await/awaitWithTimeout patterns | |
| 61 | + |
| 62 | +### Configuration |
| 63 | + |
| 64 | +| Page | Owner | Notes | |
| 65 | +|------|-------|-------| |
| 66 | +| `configuration/options.md` | **workflow** | Package configuration reference | |
| 67 | +| `configuration/database-connection.md` | **workflow** | Database requirements, multi-connection | |
| 68 | +| `configuration/publishing-config.md` | **workflow** | Config file publishing | |
| 69 | +| `configuration/pruning-workflows.md` | **workflow** | Retention, cleanup | |
| 70 | +| `configuration/ensuring-same-server.md` | **workflow** | Development config | |
| 71 | +| `configuration/microservices.md` | **workflow** | Multi-service orchestration | |
| 72 | +| `configuration/worker-protocol.md` | **server** | HTTP worker protocol specification | |
| 73 | + |
| 74 | +### Constraints |
| 75 | + |
| 76 | +| Page | Owner | Notes | |
| 77 | +|------|-------|-------| |
| 78 | +| `constraints/overview.md` | **workflow** | Constraint philosophy | |
| 79 | +| `constraints/workflow-constraints.md` | **workflow** | Workflow code rules | |
| 80 | +| `constraints/activity-constraints.md` | **workflow** | Activity code rules | |
| 81 | +| `constraints/structural-limits.md` | **workflow** | History size, event limits | |
| 82 | +| `constraints/constraints-summary.md` | **workflow** | Quick reference | |
| 83 | + |
| 84 | +### Testing & Operations |
| 85 | + |
| 86 | +| Page | Owner | Notes | |
| 87 | +|------|-------|-------| |
| 88 | +| `testing.md` | **workflow** | Testing strategies, test helpers | |
| 89 | +| `failures-and-recovery.md` | **workflow** | Failure handling, retries, recovery | |
| 90 | +| `monitoring.md` | **waterline** | Waterline UI, observability | |
| 91 | +| `sample-app.md` | **sample-app** | Sample application reference | |
| 92 | + |
| 93 | +### SDKs |
| 94 | + |
| 95 | +| Page | Owner | Notes | |
| 96 | +|------|-------|-------| |
| 97 | +| `sdks/python.md` | **sdk-python** | Python SDK installation, usage | |
| 98 | + |
| 99 | +### Meta |
| 100 | + |
| 101 | +| Page | Owner | Notes | |
| 102 | +|------|-------|-------| |
| 103 | +| `sponsors.md` | **docs** | Sponsorship info | |
| 104 | +| `support.md` | **docs** | Support channels | |
| 105 | + |
| 106 | +## Plan References |
| 107 | + |
| 108 | +- **Workflow package plan**: workflows/features live in `workflow` v2 branch |
| 109 | +- **Server plan**: server setup, worker protocol in `server` main branch |
| 110 | +- **CLI plan**: CLI docs track `cli` main branch |
| 111 | +- **Python SDK plan**: `/home/lab/workspace-hq/docs/sdk-python/plan.md` |
| 112 | +- **Waterline plan**: monitoring/observability features track `waterline` v2 branch |
| 113 | +- **Docs plan**: `/home/lab/workspace-hq/docs/durable-workflow.github.io/plan.md` |
| 114 | + |
| 115 | +## How to Use This Map |
| 116 | + |
| 117 | +### Fixing inaccurate docs |
| 118 | + |
| 119 | +1. Find the page in the table above |
| 120 | +2. Check the owner repo |
| 121 | +3. Read the corresponding source code to understand current behavior |
| 122 | +4. Update the docs to match |
| 123 | +5. If the behavior should change, file an issue in the owner repo |
| 124 | + |
| 125 | +### Adding feature documentation |
| 126 | + |
| 127 | +1. Identify which repo implements the feature |
| 128 | +2. Find related docs pages in the table |
| 129 | +3. Add documentation near related content |
| 130 | +4. Update this ownership map if creating a new page |
| 131 | + |
| 132 | +### Reporting docs issues |
| 133 | + |
| 134 | +When filing `docs-feedback` issues, reference the owner repo so the issue can be routed to the right team. |
| 135 | + |
| 136 | +## Drift Detection |
| 137 | + |
| 138 | +To audit for content drift: |
| 139 | + |
| 140 | +1. For each page, check the "last modified" date |
| 141 | +2. Compare against recent commits in the owner repo |
| 142 | +3. If owner repo has significant changes since last docs update, flag for review |
| 143 | +4. Create tracking issues for confirmed drift |
| 144 | + |
| 145 | +Last ownership audit: 2026-04-15 |
0 commit comments