Regenerate Documentation #120
Conversation
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (39)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including You can disable this status message by setting the
📝 WalkthroughWalkthroughTwo new documentation guide files establish standards for Capy project documentation. The first defines the rebuild process, structure, and style conventions. The second prescribes writing principles, tone, formatting rules, and workflow guidance for documentation creation. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @.cursor/commands/doc-rebuild.md:
- Around line 16-35: Remove the extra leading indentation on the nested bullet
lines inside the verbatim sections so list markers are flush-left (fix the lists
under the headings "2. **What This Library Does**", "3. **What This Library Does
Not Do**", and "4. **Target Audience**"); edit each verbatim bullet block in
.cursor/commands/doc-rebuild.md to delete the extra spaces before "-" or "*" so
markdownlint MD007 is satisfied, and apply the same adjustment to any other
similar verbatim list blocks in the file.
| 2. **What This Library Does** (verbatim): | ||
| - Lazy coroutine tasks — `task<T>` with forward-propagating stop tokens and automatic cancellation | ||
| - Buffer sequences — taken straight from Asio and improved | ||
| - Stream concepts — `ReadStream`, `WriteStream`, `ReadSource`, `WriteSink`, `BufferSource`, `BufferSink` | ||
| - Type-erased streams — `any_stream`, `any_read_stream`, `any_write_stream` for fast compilation | ||
| - Concurrency facilities — executors, strands, thread pools, `when_all`, `when_any` | ||
| - Test utilities — mock streams, mock sources/sinks, error injection | ||
| 3. **What This Library Does Not Do** (verbatim): | ||
| - Networking — no sockets, acceptors, or DNS; that's what Corosio provides | ||
| - Protocols — no HTTP, WebSocket, or TLS; see the Http and Beast2 libraries | ||
| - Platform event loops — no io_uring, IOCP, epoll, or kqueue; Capy is the layer above | ||
| - Callbacks or futures — coroutine-only means no other continuation styles | ||
| - Sender/receiver — Capy uses the IoAwaitable protocol, not `std::execution` | ||
| 4. **Target Audience** (verbatim): | ||
| - Users of Corosio — portable coroutine networking | ||
| - Users of Http — sans-I/O HTTP/1.1 clients and servers | ||
| - Users of Websocket — sans-I/O WebSocket | ||
| - Users of Beast2 — high-level HTTP/WebSocket servers | ||
| - Users of Burl — high-level HTTP client | ||
| All of these are built on Capy. Understanding its concepts—tasks, buffer sequences, streams, executors—unlocks the full power of the stack. |
There was a problem hiding this comment.
Fix unordered-list indentation to satisfy MD007.
The nested bullets in these verbatim sections are indented when they should be flush-left, triggering markdownlint MD007. Please remove the extra indentation for these lists and apply the same adjustment to the similar verbatim bullet blocks throughout the file.
🧹 Suggested fix (apply consistently to all similar blocks)
- - Lazy coroutine tasks — `task<T>` with forward-propagating stop tokens and automatic cancellation
- - Buffer sequences — taken straight from Asio and improved
- - Stream concepts — `ReadStream`, `WriteStream`, `ReadSource`, `WriteSink`, `BufferSource`, `BufferSink`
- - Type-erased streams — `any_stream`, `any_read_stream`, `any_write_stream` for fast compilation
- - Concurrency facilities — executors, strands, thread pools, `when_all`, `when_any`
- - Test utilities — mock streams, mock sources/sinks, error injection
+ - Lazy coroutine tasks — `task<T>` with forward-propagating stop tokens and automatic cancellation
+ - Buffer sequences — taken straight from Asio and improved
+ - Stream concepts — `ReadStream`, `WriteStream`, `ReadSource`, `WriteSink`, `BufferSource`, `BufferSink`
+ - Type-erased streams — `any_stream`, `any_read_stream`, `any_write_stream` for fast compilation
+ - Concurrency facilities — executors, strands, thread pools, `when_all`, `when_any`
+ - Test utilities — mock streams, mock sources/sinks, error injection🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 17-17: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 18-18: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 19-19: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 20-20: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 21-21: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 22-22: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 24-24: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 25-25: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 26-26: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 27-27: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 28-28: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 30-30: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 31-31: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 32-32: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 33-33: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
[warning] 34-34: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
🤖 Prompt for AI Agents
In @.cursor/commands/doc-rebuild.md around lines 16 - 35, Remove the extra
leading indentation on the nested bullet lines inside the verbatim sections so
list markers are flush-left (fix the lists under the headings "2. **What This
Library Does**", "3. **What This Library Does Not Do**", and "4. **Target
Audience**"); edit each verbatim bullet block in .cursor/commands/doc-rebuild.md
to delete the extra spaces before "-" or "*" so markdownlint MD007 is satisfied,
and apply the same adjustment to any other similar verbatim list blocks in the
file.
|
An automated preview of the documentation is available at https://120.capy.prtest3.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-02-01 07:03:05 UTC |
|
GCOVR code coverage report https://120.capy.prtest3.cppalliance.org/gcovr/index.html Build time: 2026-02-01 07:07:11 UTC |
2 participants
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.