docs: Mention SEED-0102 in module_structure.rst
Bug: b/286477675
Change-Id: Iaabef9fe99a7874f0f23c51e49beef46f00ef921
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/157234
Reviewed-by: Chad Norvell <chadnorvell@google.com>
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed-service-accounts.iam.gserviceaccount.com>
Reviewed-by: Kayce Basques <kayce@google.com>
Commit-Queue: Chad Norvell <chadnorvell@google.com>
Pigweed-Auto-Submit: Kayce Basques <kayce@google.com>
diff --git a/docs/module_structure.rst b/docs/module_structure.rst
index cfd7557..c952ecc 100644
--- a/docs/module_structure.rst
+++ b/docs/module_structure.rst
@@ -17,8 +17,14 @@
pw_foo/...
- docs.rst # If there is just 1 docs file, call it docs.rst
- README.md # All modules must have a short README for gittiles
+ docs.rst # Docs landing page (required)
+ concepts.rst # Conceptual docs (optional)
+ design.rst # Design docs (optional)
+ guides.rst # How-to guides (optional)
+ api.rst # API reference (optional)
+ cli.rst # CLI reference (optional)
+ gui.rst # GUI reference (optional)
+ tutorials/*.rst # Tutorials (optional)
BUILD.gn # GN build required
BUILD # Bazel build required
@@ -419,30 +425,7 @@
Documentation
-------------
-Documentation should go in the root module folder, typically in the
-``docs.rst`` file. There must be a docgen entry for the documentation in the
-``BUILD.gn`` file with the target name ``docs``; so the full target for the
-docs would be ``<module>:docs``.
-
-.. code-block::
-
- pw_example_module/...
-
- docs.rst
-
-For modules with more involved documentation, create a separate directory
-called ``docs/`` under the module root, and put the ``.rst`` files and other
-related files (like images and diagrams) there.
-
-.. code-block::
-
- pw_example_module/...
-
- docs/docs.rst
- docs/bar.rst
- docs/foo.rst
- docs/image/screenshot.png
- docs/image/diagram.svg
+See :ref:`seed-0102`.
Creating a new Pigweed module
-----------------------------
@@ -466,6 +449,7 @@
- Add ``{pw_module_dir}/README.md`` that has a module summary
- Add ``{pw_module_dir}/docs.rst`` that contains the main module
documentation
+ - Add optional documentation as described in :ref:`seed-0102`
5. Add GN build support in ``{pw_module_dir}/BUILD.gn``
