Lines Matching full:documentation

4 0102: Consistent Module Documentation
8    :fas:`seedling` SEED-0102: :ref:`Consistent Module Documentation<seed-0102>`
26 Pigweed modules ought to have documentation that is reasonably comprehensive,
29 them. This SEED proposes a documentation philosophy applicable to all Pigweed
37 primary focus of this SEED is to improve the documentation experience for users.
43 ``docs.rst`` file that contains the module's documentation. This gives the
45 documentation as they would like. However, this approach fails for Pigweed
47 documentation, and certainly fails Pigweed users who struggle to find the
49 Pigweed maintainers to write good documentation, thereby making Pigweed much
52 Pigweed's design is inherently and intentionally modular. So documentation at
55 documentation. Module docs are also what the majority of Pigweed users rely on
57 documentation.
60 documentation, illustrated below with terminology altered to better match
72 maintainers to write effective documentation, and a single page that provides
84 * Likewise, focusing on module documentation reduces focus on content that
87 The justification for focusing on module documentation doesn't imply that module
97 2. It will be easier to construct higher-level and cross-cutting documentation
144 Some modules may need documentation on fundamental concepts that are independent
168 Modules should have reference documentation for their user-facing APIs. Modules
178 if the module provides one. It's ideal if this documentation closely matches the
182 interfaces and web front-ends), its documentation should be included in
196 module's documentation and should be appropriate to the vast majority of
198 documentation needs that are not met by this structure are free to deviate from