> For the complete documentation index, see [llms.txt](https://docs.umbraco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.umbraco.com/contributing/documentation/getting-started.md).

# How to Contribute

Whether you've found a broken link or want to add a new article, this guide will help you contribute to the Umbraco documentation.

The Umbraco Documentation is presented here on [GitBook](https://docs.umbraco.com). The documentation is also available as a [GitHub repository](https://github.com/umbraco/UmbracoDocs) and is open-source, just like the [Umbraco CMS](https://github.com/umbraco/Umbraco-CMS).

You can contribute to the documentation if something is missing or outdated. **A GitHub account and a fork of the UmbracoDocs GitHub repository are required**.

## How to Get Started

There are many ways in which you can contribute to the Umbraco Documentation. The approach you choose to take depends on what you want to achieve with your contribution.

* Request a quick/minor change to an article by submitting a [Pull Request](/contributing/documentation/getting-started/pull-request.md#option-1-creating-a-pr-directly-on-github).
* Submit a more extensive update or change by [forking the Documentation repository](/contributing/documentation/getting-started/pull-request.md#options-2-creating-a-pr-through-a-fork).
* Raise a question, start a discussion, or report an issue on the [Issue Tracker](/contributing/documentation/getting-started/issues.md).
* Help improve the readability of the documentation by verifying articles against our [Style Guide](/contributing/documentation/style-guide.md#test-the-documentation-yourself).

## [Style guide](/contributing/documentation/style-guide.md)

Consistency and readability are important when writing and reading documentation. When you contribute, follow the style guidelines and rules outlined in the Style Guide.

## [Markdown and formatting](/contributing/documentation/style-guide/markdown-conventions.md)

The Umbraco Documentation is written using the Markdown markup language.

## [File names and structure](/contributing/documentation/style-guide/structure.md)

Learn how we structure and name files in the Umbraco documentation.

## Writing documentation locally

Use a text editor like Visual Studio Code to make changes to the documentation locally. Although it is possible, it is not recommended to use an Integrated Development Environment (IDE) like Visual Studio for making changes to the documentation on your local machine. This is because the IDE may create files in the project that are not needed for the document changes to be implemented.

## Multi-version documentation

Whenever a new version of an Umbraco product is released, the previous way of doing things may change. This means that multiple versions of our documentation must exist.

Versioning is done via the file structure, where all versioned products are located under a folder named by the major version of Umbraco.

For example, version folders such as '10' and '11' contain documentation specific to those product versions.

<figure><img src="https://856798538-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGZT90nw78UUj3rPFXrPV%2Fuploads%2Fgit-blob-51f0816133f19b991caab775b5e8cc7a0654a1ef%2Frepository-folder-structure.png?alt=media" alt=""><figcaption><p>An overview of the file structure in the UmbracoDocs GitHub repository.</p></figcaption></figure>

Umbraco Cloud and Umbraco Heartcore are not documented by version, which is why they are separate from this structure.

Learn more about how versioning is managed in the [Documenting multiple versions and products ](https://docs.umbraco.com/welcome/documentation-and-versions)article.

## Labels

On both Issues and Pull Requests, labels are used to categorize the requests and submissions.

Here's a quick explanation of the labels (colors):

* **Category**
  * `category/missing-documentation`
  * `category/umbraco-cloud`
  * `category/pending-release`
* **Community**
  * `community/pr`
  * `help wanted`
* **State**
  * `state/hq-discussion`
* **Status**
  * `status/awaiting-feedback`
  * `status/idea`
* **Type**
  * `type/bug`
* **Internal Review**
  * `review/docsteam`
  * `review/developer`

Labels are added during the initial review of your pull request or issue.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.umbraco.com/contributing/documentation/getting-started.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
