view website/www/docs.txt @ 7744:6985f0ff3df3

doc: document lib, fix formating/example Add lib as an optional directory in a template. Make config_ini.ini example an actual code block using the file from the jinja2 template. Format the TEMPLATE-INFO.txt example as plain text (it was highlighting words like 'in' and 'with'). Also move the whole example under the bullet item, it was outside of the list. Reformat the input text to be less than 80 characters.
author John Rouillard <rouilj@ieee.org>
date Mon, 26 Feb 2024 11:23:36 -0500
parents e3b35dcf0dcb
children e3b34d02c61a
line wrap: on
line source

.. meta::
    :description:
        Table of contents for published documentation on the Roundup
        Issue Tracker.

Docs
====

.. admonition:: Welcome

   The documentation is slowly being reorganized using the `Diataxis
   framework`_. Help with the reorganization is welcome. If a page you
   used to see is missing, try checking the `Other Docs
   <olderdocs.html>`_ page.

See: https://wiki.roundup-tracker.org/ReleaseErrata for fixes to
documentation.

.. _diataxis framework: https://diataxis.fr/

.. toctree::
   :maxdepth: 2

   Features <docs/features>
   Installation <docs/installation>
   Upgrading to Newer Versions <docs/upgrading>
   Security Issues <docs/security>
   FAQ <docs/FAQ>
   User's Guide <docs/user_guide>
   Customising <docs/customizing>
   Rest API <docs/rest>
   XML-RPC API <docs/xmlrpc>
   Reference <docs/reference>
   Glossary <docs/glossary>
   docs/admin_guide
   docs/license
   docs/acknowledgements
   olderdocs

Roundup Issue Tracker: http://roundup-tracker.org/