About LinkAhead Documentation#
This is the LinkAhead Documentation.
Find the source code of LinkAhead under linkahead.
Contact#
via Mail or Matrix Chat
or Follow us on Mastodon or
Bluesky or
LinkedIn
Contribute#
We organize our documentation according to the Diataxis taxonomy, which separates content by user intent rather than format or audience. Documentation is divided into five main categories: Tutorial, How-to Guides, Explanation, Reference and About. Each category answers a different kind of question and serves a distinct role within the documentation.
These categories are represented as sections in src/content, and each section contains a table of
content (toctree) with a desired structure. The goal is to identify a meaningful place for your
content to ensure that it aligns with the intended purpose of each section.
Structure overview: Together, the five categories form a complete and non-overlapping documentation system:
Tutorials help users get started.
How-to Guides help users get things done.
Explanation helps users understand.
Reference helps users look up details.
About helps contributors and users orient themselves within the project.
Each document belongs to exactly one category, based on its primary purpose. The corresponding
content is stored in folders mirroring the section structure in src/content, which should
support you navigating through the folder structure.
Tutorials:#
The tutorials are learning-oriented and aim to improve understanding of the high-level concepts and
functions of LinkAhead. They are designed for newcomers and focus on doing, not explaining theory. A
tutorial should introduce its topic in a way suitable for beginners and guide the user through the
complete process to learn a new skill or gain familiarity with a new tool or feature.
Example: “Using the LinkAhead WebUI”
How-to Guides:#
How-to Guides (or Goals) are task-oriented, step-by-step instructions on how to accomplish specific
goals or solve a particular well-defined problem, such as migrating from one version of LinkAhead to
another or configuring a certain feature. They are aimed at users who have a basic familiarity with
LinkAhead and explain how to solve common problems or perform particular tasks, including best
practices where applicable. These guides are practical, focused, and reusable, without walking
through every detail from scratch.
Example: “How to Trigger Serverside Scripts”
Explanation & Reference:#
This category is understanding- and information-oriented. The Explanation section provides background
information and explains the reasoning behind underlying concepts and design decisions. The Reference
section offers precise, structured technical reference material (e.g. APIs, configuration options,
modules) intended for lookup rather than reading end to end.
Example: “The CaosDB Data Model”
About:#
The About section contains project-level and organizational information. It explains how the project
is structured, how to contribute, which guidelines apply, and where to find support. This content is
not about using the software, but about working with and around the project.
Example: “How to create a merge request”