Skip to content

Commit

Permalink
pw_{async2,channel}: Start FAQ sections
Browse files Browse the repository at this point in the history
Change-Id: I9174642077e08c55408dc01622deacf1ceb5c628
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246735
Reviewed-by: Taylor Cramer <[email protected]>
Presubmit-Verified: CQ Bot Account <[email protected]>
Lint: Lint 🤖 <[email protected]>
Commit-Queue: Kayce Basques <[email protected]>
  • Loading branch information
Kayce Basques authored and CQ Bot Account committed Nov 4, 2024
1 parent 1c6d9e8 commit 4fbb15f
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 0 deletions.
6 changes: 6 additions & 0 deletions pw_async2/guides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
---------------------------------
1 change: 1 addition & 0 deletions pw_channel/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ pw_doc_group("docs") {
sources = [
"design.rst",
"docs.rst",
"guides.rst",
"reference.rst",
]
}
Expand Down
1 change: 1 addition & 0 deletions pw_channel/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,6 @@ flow control, backpressure, composability, and more.
.. toctree::
:hidden:

guides
design
reference
13 changes: 13 additions & 0 deletions pw_channel/guides.rst
Original file line number Diff line number Diff line change
@@ -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)
---------------------------------

0 comments on commit 4fbb15f

Please sign in to comment.