[TheLingeringWill]

Part of cppalliance/capy#416.

The Boost review asked that the reference break the API into sections by purpose,
"similar for Corosio". cppalliance/capy#484 did this for Capy. This does the same for
Corosio, using only what MrDocs already produces: its tagfile and the cpp: macro. The
generated index is unchanged, and is now named "Index by Kind", as in Capy.

Changes

• doc/modules/ROOT/pages/reference-overview.adoc (new): fifteen sections:

  • I/O Context and I/O Backends
  • I/O Objects and Streams
  • TCP
  • Addresses and Endpoints
  • Name Resolution
  • UDP
  • Unix Domain Sockets
  • Socket Options
  • Delays and Timeouts
  • Signals
  • Files
  • Native Descriptors and Handles
  • TLS
  • Errors
  • Native Types

  Each section has a short intro that links the guide pages teaching it, and a
  Kind | Names table. The tables list every symbol on the generated boost::corosio
  and socket_option index pages once (114 names), except namespaces and operators, as
  cpp: links.

• nav.adoc: "Reference" now opens the overview, with one child per section and an
  "Index by Kind" child for the generated index.

• glossary.adoc: the See Also section links both pages.

• STYLE_GUIDE.md E3: records the page, and that an API change must update it in the
  same pull request.

The test tools in boost::corosio::test are not in the generated reference, because MrDocs
parses only <boost/corosio.hpp> and native/native.hpp. The overview says so and links
the Testing section instead.

[coderabbitai]

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters: 4

• doc/STYLE_GUIDE.md is excluded by !**/doc/**
• doc/modules/ROOT/nav.adoc is excluded by !**/doc/**
• doc/modules/ROOT/pages/glossary.adoc is excluded by !**/doc/**
• doc/modules/ROOT/pages/reference-overview.adoc is excluded by !**/doc/**

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

Run configuration

• Source mode: Auto
• Repository: cppalliance/corosio
• Branch: develop
• File: .coderabbit.yaml
• Commit: 13bcf93
• Layers: Repository YAML
• Review profile: CHILL
• Plan: Advanced
• Run ID: 9675fa81-6dd1-41a8-a2be-5d8033402094

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• Trigger review

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

[greptile-apps]

Confidence Score: 5/5

[Low impact] The PR appears safe to merge; no actionable issues were found.

Summary

Adds a reference overview with fifteen sections that group the API by purpose.

• Corosio’s reference page groups API names by purpose.

No actionable issues were found. Review checks were source-based; no documentation build or visual check was run.

_{Reviews (2) · Last reviewed commit: "docs: tighten three reference overview s..." · Reviewed by Greptile}

[cppalliance-bot]

An automated preview of the documentation is available at https://417.corosio.prtest3.cppalliance.org/index.html

If more commits are pushed to the pull request, the docs will rebuild at the same URL.

2026-11-13 14:33:35 UTC

[cppalliance-bot]

GCOVR code coverage report https://417.corosio.prtest3.cppalliance.org/gcovr/index.html
LCOV code coverage report https://417.corosio.prtest3.cppalliance.org/genhtml/index.html
Coverage Diff Report https://417.corosio.prtest3.cppalliance.org/diff-report/index.html

Build time: 2026-11-13 14:52:07 UTC