Mercurial > p > roundup > code
comparison doc/reference.txt @ 7280:2a735d785836
Added new reference doc. Starter text.
Much of the start of customizing.txt will move here. Customizing.txt
will be mostly how-to and tutorials.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 25 Apr 2023 17:20:37 -0400 |
| parents | |
| children | f3c9ba5db30b |
comparison
equal
deleted
inserted
replaced
| 7279:0bf616cfa178 | 7280:2a735d785836 |
|---|---|
| 1 .. meta:: | |
| 2 :description: | |
| 3 Reference for the internals of Roundup. Includes background | |
| 4 information for cookbook and how-to examples. | |
| 5 Reference for the design and internals needed to understand | |
| 6 and extend the examples to meet new needs. | |
| 7 | |
| 8 :tocdepth: 2 | |
| 9 | |
| 10 ================= | |
| 11 Roundup Reference | |
| 12 ================= | |
| 13 | |
| 14 .. This document borrows from the ZopeBook section on ZPT. The original is at: | |
| 15 http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx | |
| 16 | |
| 17 .. contents:: | |
| 18 :depth: 2 | |
| 19 :local: | |
| 20 | |
| 21 Welcome | |
| 22 ======= | |
| 23 | |
| 24 This document used to be part of the `customization document`_. The | |
| 25 customization document was getting large and unwieldy. It was a | |
| 26 combination of examples and internal information that made finding | |
| 27 information difficult. We often had questions on the mailing list that | |
| 28 were well answered in the customization document, but finding the info | |
| 29 was difficult. | |
| 30 | |
| 31 The documentation is slowly being reorganized using the `Diataxis | |
| 32 framework`_. Help with the reorganization is welcome. | |
| 33 | |
| 34 | |
| 35 This is the document you should look at for background on a tutorial | |
| 36 or how-to guide in the customization document. | |
| 37 | |
| 38 .. _customization document: customizing.html | |
| 39 .. _diataxis framework: https://diataxis.fr/ |