# Outlines

### Introduction

**AppFlowy** is a versatile tool with a wide range of use cases. As a result, documents created in AppFlowy can vary significantly in length and complexity. To address this, it would be beneficial to develop an **Outline Plugin** that would display all of the headings in a document at the beginning, making it easier for users to scan and navigate the document.

### Goals

The goals of the AppFlowy Outline Plugin are to:

* Provide a quick and easy way to navigate through long and complex documents
* Help users to find specific information in a document more quickly
* Provide a visual overview of the document's structure
* Help users to understand the document's content

### Scope

The AppFlowy Outline Plugin will add the following new actions to the AppFlowy application:

* Users will be able to add an outline to a document using the slash (`/`) menu.
* The content of the outline will be automatically generated based on the document.
* Clicking on the content of the outline will take users directly to the corresponding heading.
* In the outline different levels of headings will be indented differently. For example, H1 will have no indentation, while H2 will be indented once, and so on.
* Only H1, H2, and H3 headings will be shown in the outline. Other elements will not be displayed or represented.

### Implementation

To keep the encapsulate the Outline feature, we created it as an `editor_plugin` and simply plugged it into the editor.

<figure><img src="/files/LCixg88ZLD200E9qgKde" alt=""><figcaption><p>Example of Outline Block</p></figcaption></figure>

### Schedule

The AppFlowy Outline Plugin has been released on 2nd July 2023 in [v0.2.5](https://github.com/AppFlowy-IO/AppFlowy/releases/tag/0.2.5).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.appflowy.io/docs/appflowy/community/appflowy-mentorship-program/mentorship-2022/mentee-projects/outlines.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.