Page MenuHomePhabricator

[MITKDoc] Documentation Refurbish - Developer Manual
Open, LowPublic

Description

Update and restructure the developer manual.

Related Objects

StatusAssignedTask
Openkompan

Event Timeline

kompan triaged this task as Normal priority.Jul 27 2020, 12:04 PM
kompan created this task.

In the developer manual section, the table of contents is repeated in each section and subsection. This is not a show-stopper, but doesn't look very nice and should be cleaned up at some point.

thomass moved this task from Backlog to Documentation on the MITK (2020) board.Jul 29 2020, 8:09 AM
kislinsk claimed this task.Sep 8 2020, 9:25 AM

Deleted branch bugfix/T27608-DocumentationRefurbish-DeveloperManual.

kislinsk added a comment.EditedSep 8 2020, 9:34 AM

I re-created the branch above, branching off from the latest develop branch.

kompan added a comment.Sep 8 2020, 9:46 AM

So far, Sarina and I changed the \section,\subsection to headings <h1>, <h2,>..., such that the table of contents doesn't have too much depth (which is confusing to navigate through). However, the more sensible way would be to keep the \section structure and instead adjust the depth of the doxygen TOC_INCLUDE_HEADINGS. The default depths is 5.

kislinsk reassigned this task from kislinsk to kompan.Sep 8 2020, 10:07 AM
kislinsk added a subscriber: kislinsk.
kompan lowered the priority of this task from Normal to Low.Sep 25 2020, 9:53 AM