annotate website/www/docs.txt @ 7346:4295ac110551

Ad skiplink to main on moblie; fix overlapping links On mobile, the Roundup label at the top of the stacked table of contents becomes a link to jump to the top of the main body of the page. Without this there is no indication that a link on the main menu has been clicked and there is a lot of scrolling to get to the real content of the page. Ideally the left sidebar would become a menu link an be shown only when activated but .... Ran the top level pages through lighthouse to see how they do on mobile. Style changes added to fix links that overlap; fix links that were incorrectly displayed as blocks rather than in running text. Fixes some spacing issues with nested lists inside definition lists definition (dd) tags. Removed some indent when TOC follows n H1 header. Wrap search box on smaller screens so the search box doesn't overlap the jump link. Add back left margin to footer. Tried to prevent overlap with the prev/next/index submenu. It's better but still not good.
author John Rouillard <rouilj@ieee.org>
date Sun, 14 May 2023 15:39:13 -0400
parents 5eadba24e148
children 79fd1bf20543
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7048
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
1 .. meta::
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
2 :description:
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
3 Table of contents for published documentation on the Roundup
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
4 Issue Tracker.
6f5054751fb6 Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents: 5941
diff changeset
5
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
6 Docs
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
7 ====
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
8
7328
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
9 .. note::
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
10 The documentation is slowly being reorganized using the `Diataxis
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
11 framework`_. Help with the reorganization is welcome. If a page you
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
12 used to see is missing, try checking the `Other Docs
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
13 <olderdocs.html>`_ page.
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
14
7339
5eadba24e148 add reference to ReleaseErrata in the wiki
John Rouillard <rouilj@ieee.org>
parents: 7328
diff changeset
15 See: https://wiki.roundup-tracker.org/ReleaseErrata for fixes to
5eadba24e148 add reference to ReleaseErrata in the wiki
John Rouillard <rouilj@ieee.org>
parents: 7328
diff changeset
16 documentation.
5eadba24e148 add reference to ReleaseErrata in the wiki
John Rouillard <rouilj@ieee.org>
parents: 7328
diff changeset
17
7328
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
18 .. _diataxis framework: https://diataxis.fr/
ce156ad03cb6 add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
19
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
20 .. toctree::
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
21 :maxdepth: 2
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
22
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
23 docs/features
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
24 docs/installation
4610
e793eafba69c Documentation: Synced the doc/index.txt and docs.txt. Removed outdated contact.txt.
Bernhard Reiter <bernhard@intevation.de>
parents: 4441
diff changeset
25 docs/upgrading
7100
8a267e9827cc Integrate security.txt with website docs. Align TOCs.
John Rouillard <rouilj@ieee.org>
parents: 7048
diff changeset
26 docs/security
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
27 docs/FAQ
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
28 docs/user_guide
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
29 docs/customizing
7322
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents: 7283
diff changeset
30 docs/rest
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents: 7283
diff changeset
31 docs/xmlrpc
7283
1a0548b60c6b Update document TOC with security-history, reference, upgrading-history
John Rouillard <rouilj@ieee.org>
parents: 7100
diff changeset
32 docs/reference
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 4610
diff changeset
33 docs/glossary
7322
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents: 7283
diff changeset
34 docs/admin_guide
5941
29d428927362 prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents: 4610
diff changeset
35 docs/license
7322
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents: 7283
diff changeset
36 docs/acknowledgements
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents: 7283
diff changeset
37 olderdocs

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