Skip to content

Commit c02a4a4

Browse files
committed
add welcome preface on reorg to pages
1 parent 591d32c commit c02a4a4

File tree

2 files changed

+29
-19
lines changed

2 files changed

+29
-19
lines changed

doc/customizing.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,17 @@ Customising Roundup
1515
.. This document borrows from the ZopeBook section on ZPT. The original is at:
1616
http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
1717

18+
.. admonition:: Welcome
19+
20+
This document used to be much larger and include a lot of
21+
reference material. That has been moved to the `reference document`_.
22+
23+
The documentation is slowly being reorganized using the `Diataxis
24+
framework`_. Help with the reorganization is welcome.
25+
26+
.. _reference document: reference.html
27+
.. _diataxis framework: https://diataxis.fr/
28+
1829
.. contents::
1930
:depth: 3
2031
:local:

doc/reference.txt

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,30 @@
1111
Roundup Reference
1212
=================
1313

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
14+
.. admonition:: Welcome
1615

17-
.. contents::
18-
:depth: 2
19-
:local:
16+
This document used to be part of the `customization document`_. The
17+
customization document was getting large and unwieldy. It was a
18+
combination of examples and internal information that made finding
19+
information difficult. We often had questions on the mailing list that
20+
were well answered in the customization document, but finding the info
21+
was difficult.
2022

21-
Welcome
22-
=======
23+
The documentation is slowly being reorganized using the `Diataxis
24+
framework`_. Help with the reorganization is welcome.
2325

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.
26+
This is the document you should look at for background on a tutorial
27+
or how-to guide in the customization document.
3028

31-
The documentation is slowly being reorganized using the `Diataxis
32-
framework`_. Help with the reorganization is welcome.
29+
.. _customization document: customizing.html
30+
.. _diataxis framework: https://diataxis.fr/
3331

34-
This is the document you should look at for background on a tutorial
35-
or how-to guide in the customization document.
32+
.. This document borrows from the ZopeBook section on ZPT. The original is at:
33+
http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
3634

37-
.. _customization document: customizing.html
38-
.. _diataxis framework: https://diataxis.fr/
35+
.. contents::
36+
:depth: 2
37+
:local:
3938

4039
Trackers in a Nutshell
4140
======================

0 commit comments

Comments
 (0)