Pages and structure

Last modified: 2026-11-20 01:51by Erik Hagen ID: 4a92bf24-774e-4490-94f0-00af2184712f SAMT-X/solution-samt-bu-docs

The conventions below apply to all pages on the site. They mean readers find their way the same way everywhere, and that we do not have to discuss the structure again for each section.

Pages with subpages: lead text only

A page that has subpages has only a short lead text of two to four sentences. Below the lead text the site automatically shows the section content, i.e. the list of subpages. Example: Pilot 6.

  • Do not put other content on such a page. Content placed there is easily «hidden» behind the list and has no place of its own in the menu.
  • If the content needs a page of its own, create it as a subpage, for example «About …».

One page, one document

A document with chapters is placed as one page, not as one subpage per chapter. The chapters are shown in the menu on the right («On this page»), and readers can jump between them.

  • Chapters are level 2 headings (Heading 2 in the editor), sub-chapters level 3. Level 1 is the page title.
  • Use subpages only when the content is a separate unit that can be read on its own, for example minutes of meetings or a deliverable.

No chapter numbering

Headings are not numbered («Technical target architecture», not «9. Technical target architecture»).

  • References to other chapters are written as links with the name of the chapter, for example «see Technical target architecture», where the name links to the chapter. The anchor is the heading in lower case with hyphens between the words (#technical-target-architecture). The easiest way is to copy the link with the link icon, see below.
  • If an exact reference to a page is needed, use the page’s ID (shown below the title) and the date it was last changed. The version history is in GitHub.
  • Numbering that belongs to the source is kept: reference lists [1], [2], sections of acts, numbered principles and figure numbers.

Hover over a heading or the page title and a link icon appears. Click it to copy the link to the heading (or the page) to the clipboard.

Tasks and progress

Sub-projects and solutions with tasks in GitHub have the page «Tasks and progress». It comes right after «About …» (or «Background and rationale»), and first where there is no such page.

Conventions for specific sections