---
last_review: "2025-05-06"
last_reviewer: "Timm Fitschen"
documented_code: []
---

# LinkAhead Documentation


```{toctree}
:caption: 'The LinkAhead Documentation'
:hidden:
:maxdepth: 4

Tutorials <tutorial/index>
How‑To <how_to/index>
Explanation <explanation/index>
Reference <reference/index>
About <about/index>
Tags </_tags/tagsindex>
Glossary <glossary>
```

## What Is LinkAhead?

```{include} tutorial/introduction/30seconds_intro.md
```

## Start now

::::{grid} 3
:::{grid-item-card} Getting Started
:link: tutorial/introduction/index.html

First steps with LinkAhead.
:::

:::{grid-item-card} Web Interface
:link: tutorial/webinterface/index.html

Introduction to the web interface
:::

:::{grid-item-card} Install LinkAhead
:link: how_to/admin_guides/installation.html

Step-by-step installation.
:::
::::

::::{grid} 3
:::{grid-item-card} LinkAhead Python Library
:link: tutorial/scripting/pylib/index.html

Accessing LinkAhead using the Python client library.
:::

:::{grid-item-card} LinkAhead Crawler
:link: tutorial/crawler/index.html

Crawling data into LinkAhead.
:::

:::{grid-item-card} Concepts
:link: explanation/general/index.html

Understand how LinkAhead works.
:::

::::

## How to Read the Documentation

The documentation contains all the information you need to use LinkAhead and is divided into four 
chapters which you can access via the top menu bar. These divide the documentation by the goal of 
each page, as seen below. For further information on the different document types, refer to the
[diátaxis documentation](https://diataxis.fr/tutorials/).

| Tutorials           | How-To-Guides            | Explanation             | Reference              |
|---------------------|--------------------------|-------------------------|------------------------|
| Learning new skills | Achieving concrete goals | Understanding LinkAhead | Looking up information |

Once you've selected one of the menu items, an overview of all the individual topic sections appears
on the left-hand side. After selecting a topic, you can see on the right-hand side which subtopics
are included within that section.

Additionally, you can find further information in the drop down menu under "More". Return to this
page by clicking on the logo on the left side of the menu.

## Report an issue

Please report all bugs, feature request, or other issues with LinkAhead itself or this documentation
by opening an issue in the [official LinkAhead repository](https://gitlab.com/linkahead/linkahead/-/issues).