Page MenuHomePhabricator
Create Task
Maniphest T27608

[MITKDoc] Documentation Refurbish - Developer Manual
Open, LowPublic
Actions

Description

Update and restructure the developer manual.

Related Objects
Search...

StatusAssignedTask
Restricted Maniphest Task
 OpenNoneT27608 [MITKDoc] Documentation Refurbish - Developer Manual

Event Timeline

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

Pushed new branch bugfix/T27608-DocumentationRefurbish-DeveloperManual.

kompan added a comment.Jul 28 2020, 10:33 AM

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 (v2021.02) board.Jul 29 2020, 8:09 AM
kislinsk claimed this task.Sep 8 2020, 9:25 AM
kislinsk added a comment.Sep 8 2020, 9:33 AM

Deleted branch bugfix/T27608-DocumentationRefurbish-DeveloperManual.

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

Pushed new 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
kislinsk added a comment.Nov 15 2020, 12:34 PM

Deleted branch bugfix/T27608-DocumentationRefurbish-DeveloperManual.

floca added a subscriber: floca.Dec 9 2020, 2:23 PM

@kompan What is the status here? Is it finish. If not, what has to be done to close it. Should be done before we make a release in january and if much is left, we should know what to do. Thanks.

kislinsk edited projects, added MITK, Next Milestone; removed MITK (v2021.02).Mar 10 2021, 9:09 AM
kislinsk edited projects, added MITK (v2022.04); removed Next Milestone, MITK.Nov 16 2021, 9:23 AM
kompan removed kompan as the assignee of this task.Feb 9 2022, 11:28 AM
kislinsk edited projects, added Next Milestone, MITK; removed MITK (v2022.04).Apr 29 2022, 1:39 PM
kislinsk edited projects, added MITK (v2023.12); removed MITK, Next Milestone.May 17 2023, 2:57 PM
kislinsk edited projects, added MITK (v2024.06); removed MITK (v2023.12).Dec 5 2023, 10:38 AM
MITK · MIC · IMSY · DKFZ