Skip to content

Documentation Blueprints

Don't forget, today's documentation is tomorrow's time saver! 📚 ✍

Documentation is hosted here: (you are here but anyways).

Style Guide is found here.

How to Edit the Docs

These docs are hosted on GitLab Pages, meaning every page is just a simple .md file stored in the 'docs' repository.

At the top-right of most pages, you'll see a few icons. If you hover over them you should get the idea of what they do, incase you don't let's look at them together:

About the page icons

Add New Page Here ➝ Click on it to create a subpage under the current page

Edit in Web IDE ➝ (Best for quick documentation updates) Click on it ➝ Make your edits ➝ Go to Source Control ➝ Write a commit message ➝ Push & commit! (ATTENTION: Changes appear after a few minutes—be patient while the pipeline runs)

Edit This Page ➝ Takes you directly to the .md file in the GitLab repo

Each page automatically generates "Table of Contents (TOC)" based on the headings, see it on the right side of a page.

New Page?

When adding a new file/page, it must start with a title, but the first header will be the page title.

F.x this page has this setup in the first lines: 

---
title: Documentation Guide
---

# Documentation Blueprints

And you see how that's rendered :)

Naming Conventions!

Use consistent conventions, uppercase the firts letter, than lowercase with underscores separating words, for example Deploy_Website (folder) and Deploy_Website.md (Markdown file).

Want Images?

If images are used, create a folder named image in the current folder. In there you should put all images to refer to in the documenation.

Refer to it like so:

image_name
THE cat

<figure markdown="span">
    ![image_name](/Knowledge_base/image/logo.png){ width="100" }
    <figcaption>THE cat</figcaption>
</figure>

See more details under style guide, section 'images' (look at the TOC on the right).