iotaledger / documentation-platform

Legacy documentation platform
Apache License 2.0
52 stars 13 forks source link

Define how we treat the actual content page titles and the titles in the breadcrumb #178

Closed jakubcech closed 5 years ago

jakubcech commented 5 years ago

Description

We need to think about how we're going to treat and content page headers in relation to the headers above the page (that constitute the background). The possible approaches could be:

  1. The content page header and breadcrumb page heading are matched 1:1 (without the path from the breadcrumb)
  2. There's a flexibility to define your own text as the content page heading. This can then extend the page title that is presented in the breadcrumb/menu item. This is an approach that FB docs are taking, though not 100% consistently - whether that's intentional or not I do not know.
  3. Remove the content page H1 header itself and start with a highlighted paragraph and follow up with lower-level headings only.