Skip to content

Commit ea34cb9

Browse files
committed
docs: fix pre-existing broken xrefs in index, quick-start, and 9k
Eight xrefs in `index.adoc` and `quick-start.adoc` used the old flat path style (e.g. `coroutines/tasks.adoc`) instead of the numbered prefix the rest of the site uses (`4.coroutines/4a.tasks.adoc`). Antora was emitting "target of xref not found" errors on every build. Updated all eight to point at the actual page paths. The ninth error was in `9k.Executor.adoc` (formerly `8k.Executor.adoc`), which linked to `../continuation-rationale.adoc` — that file is a markdown design note (`doc/continuation-rationale.md`), not an Antora page, so the xref could never resolve. Removed the broken link; the surrounding prose still describes what `continuation` is. Antora build now reports zero errors.
1 parent e50df52 commit ea34cb9

3 files changed

Lines changed: 9 additions & 9 deletions

File tree

doc/modules/ROOT/pages/9.design/9k.Executor.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ If the executor determines it is safe (e.g., the current thread is already assoc
4343

4444
Queues the continuation for later execution without ever executing it inline. Never blocks. The continuation is linked into the executor's internal queue via its intrusive `next` pointer -- no per-post heap allocation.
4545

46-
Both operations accept `continuation&` rather than `std::coroutine_handle<>`. A `continuation` wraps a coroutine handle with an intrusive list pointer, enabling zero-allocation queuing. See xref:../continuation-rationale.adoc[Continuation Rationale] for the design of this type.
46+
Both operations accept `continuation&` rather than `std::coroutine_handle<>`. A `continuation` wraps a coroutine handle with an intrusive list pointer, enabling zero-allocation queuing.
4747

4848
The remaining operations support context access, lifecycle management, and identity:
4949

doc/modules/ROOT/pages/index.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,8 @@ The `task<>` return type (equivalent to `task<void>`) creates a lazy coroutine t
114114
== Next Steps
115115

116116
* xref:quick-start.adoc[Quick Start] — Set up your first Capy project
117-
* xref:cpp20-coroutines/foundations.adoc[{cpp}20 Coroutines Tutorial] — Learn coroutines from the ground up
118-
* xref:concurrency/foundations.adoc[Concurrency Tutorial] — Understand threads, mutexes, and synchronization
119-
* xref:coroutines/tasks.adoc[Coroutines in Capy] — Deep dive into `task<T>` and the IoAwaitable protocol
120-
* xref:buffers/overview.adoc[Buffer Sequences] — Master the concept-driven buffer model
121-
* xref:streams/overview.adoc[Stream Concepts] — Understand the six stream concepts
117+
* xref:2.cpp20-coroutines/2a.foundations.adoc[{cpp}20 Coroutines Tutorial] — Learn coroutines from the ground up
118+
* xref:3.concurrency/3a.foundations.adoc[Concurrency Tutorial] — Understand threads, mutexes, and synchronization
119+
* xref:4.coroutines/4a.tasks.adoc[Coroutines in Capy] — Deep dive into `task<T>` and the IoAwaitable protocol
120+
* xref:5.buffers/5a.overview.adoc[Buffer Sequences] — Master the concept-driven buffer model
121+
* xref:6.streams/6a.overview.adoc[Stream Concepts] — Understand the six stream concepts

doc/modules/ROOT/pages/quick-start.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,6 @@ capy::run_async(executor)(might_fail(),
115115

116116
Now that you have a working program:
117117

118-
* xref:coroutines/tasks.adoc[Tasks] — Learn how lazy tasks work
119-
* xref:coroutines/launching.adoc[Launching Tasks] — Understand `run_async` in detail
120-
* xref:coroutines/affinity.adoc[Executor Affinity] — Control where coroutines execute
118+
* xref:4.coroutines/4a.tasks.adoc[Tasks] — Learn how lazy tasks work
119+
* xref:4.coroutines/4b.launching.adoc[Launching Tasks] — Understand `run_async` in detail
120+
* xref:4.coroutines/4c.executors.adoc[Executors and Execution Contexts] — Control where coroutines execute

0 commit comments

Comments
 (0)