OurTechCommunity / catchup

The OTC CatchUp web app and workflows.
https://catchup.ourtech.community
MIT License
15 stars 9 forks source link

`OTC CatchUp ## Summary` is not needed twice #71

Open KartikSoneji opened 2 years ago

KartikSoneji commented 2 years ago

Each individual summary page includes the heading twice.

Summary of CatchUp #90 image of catchup summary #90

sreekaransrinath commented 1 year ago

That's probably not where the About section belongs as well.

I suggest condensing it into one information dialog

KartikSoneji commented 1 year ago

Since the combined summary template is used to build both the combined and individual summaries, there are a few ways of fixing this:

  1. Use the ifdef::[] macro to only show the title while building the combined summary. combined-summary-template.adoc

    ifdef::building-combined-summary[]
    [#{catchup_display_number}]
    === link:/summary/{catchup_display_number}[OTC CatchUp #{catchup_display_number}]
    endif::[]
  2. Use tagged regions to tag the content and only include the tagged region while building the individual summaries. combined-summary-template.adoc

    # tag::title[]
    [#{catchup_display_number}]
    === link:/summary/{catchup_display_number}[OTC CatchUp #{catchup_display_number}]
    # end::title[]
  3. Remove the header from the combined summary template and add the header while generating the combined summary in the build process. (maybe also rename combined-summary-template.adoc to content.adoc since it's not just used to build the combined summary)

KartikSoneji commented 1 year ago

cc: @OurTechCommunity/core @sreekaransrinath