stevenjwest / projectmanagr

A library for organising project documentation in R Markdown.
GNU General Public License v3.0
1 stars 1 forks source link

Update Project Doc TASK headers #5

Open stevenjwest opened 8 months ago

stevenjwest commented 8 months ago

Currently the TASK headers include an OVERVIEW and LOG section like so:

### TASK 1: _TASK_TITLE_

#### OVERVIEW

#### log

Want to REMOVE teh OVERVIEW Task section header - the TASK header serves as the link to the Overview!!

Want to remove this as the Overview takes up a lot of space in the Project Doc Outline in RStudio when many tasks are declared under a Deliverable..

Change so projectmanagr functions recognise the following TASK layout:

### TASK 1: _TASK_TITLE_

__TASK_OVERVIEW__

#### log

When reading TASKS should not need to look for OVERVIEW section - the Overview is from TASK line to LOG line.

stevenjwest commented 8 months ago

ALSO amend the layout of GDTs in Project Notes:

Here is an example of RMarkdown code showing Section Layout:


## KarolinaSC : FPE Segmentation downsampled stacks {EXAMPLE GDT LINKS}

[KarolinaSC~_KAROLINA_SupCol_Personal_Project](../../KarolinaSC~_KAROLINA_SupCol_Personal_Project.Rmd)

* [GOAL 3: SC DATA PROCESSING DEVELOPMENT](../../KarolinaSC~_KAROLINA_SupCol_Personal_Project.Rmd#goal-3-sc-data-processing-development)

    + [DELIVERABLE 1: Develop FPE Segmentation SupCol CNS](../../KarolinaSC~_KAROLINA_SupCol_Personal_Project.Rmd#deliverable-1-develop-fpe-segmentation-supcol-cns)

        - [TASK 1: FPE Segmentation downsampled stacks](../../KarolinaSC~_KAROLINA_SupCol_Personal_Project.Rmd#task-1-fpe-segmentation-downsampled-stacks)

### __SUMMARY_POINT_01__ {Make Overview just the new headers to overview notes key results under this GDT)

>>>>
>>>> Summarise key insights from work in this note that fulfil the Task
>>>>

-------- TODO -------- {add new TODO separator header}
----------------------

### [] TODO_DESCRIPTION {keep same TODO_DESCRIPTION header}

* _details_of_todo_