From 4fbb15f2d0bba6c880bc3805d99cbe01a0916772 Mon Sep 17 00:00:00 2001 From: Kayce Basques Date: Mon, 4 Nov 2024 20:43:01 +0000 Subject: [PATCH] pw_{async2,channel}: Start FAQ sections MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I9174642077e08c55408dc01622deacf1ceb5c628 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246735 Reviewed-by: Taylor Cramer Presubmit-Verified: CQ Bot Account Lint: Lint 🤖 Commit-Queue: Kayce Basques --- pw_async2/guides.rst | 6 ++++++ pw_channel/BUILD.gn | 1 + pw_channel/docs.rst | 1 + pw_channel/guides.rst | 13 +++++++++++++ 4 files changed, 21 insertions(+) create mode 100644 pw_channel/guides.rst diff --git a/pw_async2/guides.rst b/pw_async2/guides.rst index 7d20f808c..e3213aa54 100644 --- a/pw_async2/guides.rst +++ b/pw_async2/guides.rst @@ -157,3 +157,9 @@ can be tested with simulated time using :cpp:class:`pw::async2::SimulatedTimeProvider`. Doing so helps avoid timing-dependent test flakes and helps ensure that tests are fast since they don't need to wait for real-world time to elapse. + +.. _module-pw_async2-guides-faqs: + +--------------------------------- +Frequently asked questions (FAQs) +--------------------------------- diff --git a/pw_channel/BUILD.gn b/pw_channel/BUILD.gn index 225e2f398..7391286b0 100644 --- a/pw_channel/BUILD.gn +++ b/pw_channel/BUILD.gn @@ -162,6 +162,7 @@ pw_doc_group("docs") { sources = [ "design.rst", "docs.rst", + "guides.rst", "reference.rst", ] } diff --git a/pw_channel/docs.rst b/pw_channel/docs.rst index a6699bd56..bd9dcbd04 100644 --- a/pw_channel/docs.rst +++ b/pw_channel/docs.rst @@ -54,5 +54,6 @@ flow control, backpressure, composability, and more. .. toctree:: :hidden: + guides design reference diff --git a/pw_channel/guides.rst b/pw_channel/guides.rst new file mode 100644 index 000000000..82ac44794 --- /dev/null +++ b/pw_channel/guides.rst @@ -0,0 +1,13 @@ +.. _module-pw_channel-quickstart-guides: + +=================== +Quickstart & guides +=================== +.. pigweed-module-subpage:: + :name: pw_channel + +.. _module-pw_channel-guides-faqs: + +--------------------------------- +Frequently asked questions (FAQs) +---------------------------------