Mercurial > p > roundup > code
changeset 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 | 0bf616cfa178 |
| children | 194093011cb7 |
| files | doc/reference.txt |
| diffstat | 1 files changed, 39 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/reference.txt Tue Apr 25 17:20:37 2023 -0400 @@ -0,0 +1,39 @@ +.. meta:: + :description: + Reference for the internals of Roundup. Includes background + information for cookbook and how-to examples. + Reference for the design and internals needed to understand + and extend the examples to meet new needs. + +:tocdepth: 2 + +================= +Roundup Reference +================= + +.. This document borrows from the ZopeBook section on ZPT. The original is at: + http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx + +.. contents:: + :depth: 2 + :local: + +Welcome +======= + +This document used to be part of the `customization document`_. The +customization document was getting large and unwieldy. It was a +combination of examples and internal information that made finding +information difficult. We often had questions on the mailing list that +were well answered in the customization document, but finding the info +was difficult. + +The documentation is slowly being reorganized using the `Diataxis +framework`_. Help with the reorganization is welcome. + + +This is the document you should look at for background on a tutorial +or how-to guide in the customization document. + +.. _customization document: customizing.html +.. _diataxis framework: https://diataxis.fr/