Skip to content

How to integrate a repository

If you have a repository and want to integrate your documentation into the Documentation Hub you can follow this guide.

Setup

  1. Your documentation need to be placed in a docs folder at the root of your repository.
  2. Install the Architecture App in your GitHub Organization (or Repository).
  3. Wait for the documentation to appear in the Hub.

Features

The Documentation Hub follows GitHub Flavored Markdown as close as possible with a few small additions. That means you should just write markdown (you could to that in your IDE or in GitHub online with the GitHub preview). Links and functionality should be fully compatible.

Frontmatter

In addition to GitHub Markdown, the Documentation Hub does allow some Frontmatter metadata. Frontmatter is an embedded YAML document at the top of the Markdown file enclosed in --- dashes at the start and end of the YAML document.

The following frontmatter properties are supported:

  • title - The title of the page. If not given, the title is created from the filename.
  • order - The sorting of the files in the files folder. It's a numeric value and will override the natural order defined by the file names.
    Another option would be to name your files with an orderable prefix.
  • tags - A YAML list of text entries. It is used to fill the glossary. Add descriptions and keywords which describes your page. Please make sure not to overflow the glossary but add sufficient tags for users to help finding your documentation.

  • teaser - This property defines the text and presentation for the homepage. It's only valid of the 'first' or 'entry' page for the documentation. That page is the page with the lowest order property or when sorted by filename, the first file. teaser on other pages is ignored.

    The teaser consists of title, roof-title and description sub-properties. It's a YAML object.

    The title and description could be simple markdown in it's own. Please be careful what you put here. It's not meant to embed full documents, but just a teasing description of your documentation or project.

Example Frontmatter

---
order: 0
title: "Page Title"
tags:
  - "tag1"
  - "tag2"
teaser:
  title: "Teaser Title"
  roof-title: "Roof Title"
  description: "Some more text here"
---

# Headline

Paragraph
Last updated: January 26, 2026 at 18:12
By: renovate-token-app[bot]