Skip to content

Commit f55cf6d

Browse files
committed
docs: fix broken intra-doc links in sdk-reference
Fixes #167 zensical build --clean surfaced 19 validation warnings from stale links in docs/sdk-reference/. Root causes: - Singular vs plural filename: links pointed at steps.md, callbacks.md, child-contexts.md, but the actual files are step.md, callback.md, child-context.md. - Stale paths from an earlier reorganization: ../advanced/error-handling.md -> ../error-handling/errors.md ../../testing/basic-tests.md -> ../../testing/index.md ../getting-started.md -> ../../getting-started/index.md error-handling.md (bare) -> ../error-handling/errors.md - Anchor slug drift: retries.md linked to #retrying-specific-errors, but the heading is "Retry only specific errors", which slugifies to retry-only-specific-errors. Also align step.md's top-level heading with the filename and with the other singular operations (# Steps -> # Step). Verified with zensical build --clean: before: 19 issues found after: No issues found
1 parent a4bc293 commit f55cf6d

8 files changed

Lines changed: 20 additions & 20 deletions

File tree

docs/sdk-reference/error-handling/retries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ ready-made retry strategy from configuration.
108108
- `jitter` A `JitterStrategy` value: `FULL`, `HALF`, or `NONE`.
109109

110110
Java does not have built-in error type filtering. Filter by error type manually inside
111-
the `RetryStrategy` lambda. See [Retrying specific errors](#retrying-specific-errors).
111+
the `RetryStrategy` lambda. See [Retrying specific errors](#retry-only-specific-errors).
112112

113113
#### JitterStrategy
114114

docs/sdk-reference/observability/logging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -403,5 +403,5 @@ structured logger that works as a drop-in replacement for the SDK's default logg
403403
## See also
404404

405405
- [Steps](../operations/step.md)
406-
- [Child contexts](../operations/child-contexts.md)
407-
- [Error handling](error-handling.md)
406+
- [Child contexts](../operations/child-context.md)
407+
- [Error handling](../error-handling/errors.md)

docs/sdk-reference/operations/child-context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,6 @@ them to verify the child context ran and produced the expected result.
319319

320320
## See also
321321

322-
- [Steps](steps.md) Run a single function with automatic checkpointing
322+
- [Steps](step.md) Run a single function with automatic checkpointing
323323
- [Parallel operations](parallel.md) Execute operations concurrently
324324
- [Map operations](map.md) Run operation for each item in a collection

docs/sdk-reference/operations/map.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -686,5 +686,5 @@ operations. Each nested map creates its own set of child contexts.
686686

687687
- [Parallel operations](parallel.md) execute different functions concurrently
688688
- [Child contexts](child-context.md) understand child context isolation
689-
- [Steps](steps.md) use steps within map functions
690-
- [Error handling](../advanced/error-handling.md) in durable functions
689+
- [Steps](step.md) use steps within map functions
690+
- [Error handling](../error-handling/errors.md) in durable functions

docs/sdk-reference/operations/parallel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -733,5 +733,5 @@ Each nested parallel creates its own set of child contexts.
733733

734734
- [Map operations](map.md) run the same function concurrently on a collection
735735
- [Child contexts](child-context.md) understand child context isolation
736-
- [Steps](steps.md) use steps within parallel branches
737-
- [Error handling](../advanced/error-handling.md) in durable functions
736+
- [Steps](step.md) use steps within parallel branches
737+
- [Error handling](../error-handling/errors.md) in durable functions

docs/sdk-reference/operations/step.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Steps
1+
# Step
22

33
## Checkpointed results
44

@@ -428,6 +428,6 @@ concurrent code path.
428428
## See also
429429

430430
- [Retries](../error-handling/retries.md)
431-
- [Testing](../../testing/basic-tests.md)
431+
- [Testing](../../testing/index.md)
432432
- [Wait operations](wait.md)
433433
- [Child contexts](child-context.md)

docs/sdk-reference/operations/wait-for-condition.md

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

55
The Wait for Condition operation polls a check function on a schedule until your code
66
signals it to stop. Behind the scenes, the check condition runs as a
7-
[durable step](steps.md), and each polling attempt is a retry, so the SDK checkpoints
7+
[durable step](step.md), and each polling attempt is a retry, so the SDK checkpoints
88
results automatically and tracks state between attempts. The function suspends between
99
attempts and does not consume Lambda execution time.
1010

@@ -16,7 +16,7 @@ you need to poll an external system until something changes, like a batch job
1616
completing, a resource becoming available, or a status reaching a terminal state.
1717

1818
If the external system will send a notification or response, use
19-
[Callbacks](callbacks.md) instead to suspend the durable function until it receives the
19+
[Callbacks](callback.md) instead to suspend the durable function until it receives the
2020
response.
2121

2222
## Walkthrough
@@ -181,6 +181,6 @@ Lambda cold start time, and current system load.
181181
## See also
182182

183183
- [Wait operations](wait.md) - Simple time-based delays
184-
- [Callbacks](callbacks.md) - Wait for external system responses
185-
- [Steps](steps.md) - Execute business logic with automatic checkpointing
186-
- [Getting Started](../getting-started.md) - Learn the basics of durable functions
184+
- [Callbacks](callback.md) - Wait for external system responses
185+
- [Steps](step.md) - Execute business logic with automatic checkpointing
186+
- [Getting Started](../../getting-started/index.md) - Learn the basics of durable functions

docs/sdk-reference/operations/wait.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You cannot cancel a wait after it has started.
2121
## When to use wait
2222

2323
Use `context.wait()` for a time-based delay. For example, use waits between
24-
[steps](steps.md) to delay the new next step in multi-step workflows.
24+
[steps](step.md) to delay the new next step in multi-step workflows.
2525

2626
### Wait for an event or status change
2727

@@ -32,7 +32,7 @@ alternatives:
3232
- [Wait for Condition](wait-for-condition.md) handles the polling loop, state
3333
tracking, and backoff for you.
3434
- **Waiting for an external system response**
35-
- [Callbacks](callbacks.md) suspend your durable function until an external system
35+
- [Callbacks](callback.md) suspend your durable function until an external system
3636
sends a response.
3737

3838
## Wait walkthrough
@@ -260,7 +260,7 @@ You can verify wait operations in your tests by inspecting the operations list:
260260

261261
## See also
262262

263-
- [Steps](steps.md) - Execute business logic with automatic checkpointing
263+
- [Steps](step.md) - Execute business logic with automatic checkpointing
264264
- [Wait for Condition](wait-for-condition.md) - Poll until a condition is met
265-
- [Callbacks](callbacks.md) - Wait for external system responses
266-
- [Getting Started](../getting-started.md) - Learn the basics of durable functions
265+
- [Callbacks](callback.md) - Wait for external system responses
266+
- [Getting Started](../../getting-started/index.md) - Learn the basics of durable functions

0 commit comments

Comments
 (0)