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

# Contributing Documentation

We welcome all contributions to improve the Sylius documentation! Whether you're fixing a typo or adding a new guide, you're helping the community grow.

### What You Need

1. A [**GitBook**](https://www.gitbook.com/) **account** (sign in with GitHub, Google, or email)
2. A **specific invite link** for the docs section you want to contribute to (see below)
3. GitBook basics - check the [documentation](https://gitbook.com/docs/).

### Access by Documentation Section

Use the correct invite link to join the relevant workspace:

| Documentation Section    | GitBook Invite Link                                                                                |
| ------------------------ | -------------------------------------------------------------------------------------------------- |
| **Main Sylius Docs**     | [Join Main Docs](https://app.gitbook.com/invite/fmYDcx6GlpT1jw8tUL38/VilghatkhvRX92iRdYRB)         |
| **Plugin Documentation** | [Join Plugin Docs](https://app.gitbook.com/invite/fmYDcx6GlpT1jw8tUL38/9TBz7ddOiDeOGqeoUlOi)       |
| **Sylius Stack**         | [Join Sylius Stack Docs](https://app.gitbook.com/invite/fmYDcx6GlpT1jw8tUL38/1mNdMKSQNcZFRbxIhyO3) |
| **FrontWing**            | [Join FrontWing Docs](https://app.gitbook.com/invite/fmYDcx6GlpT1jw8tUL38/9SnsV6mXyKw6CD5RDXVO)    |

Once you accept the invite, you'll gain access to the relevant GitBook space.

### How to Edit the Docs

> All contributions must be made **via the GitBook editor** – this allows us to preview how content looks before publishing.

#### 1. **Find the Section You Want to Improve**

* Use the left sidebar to browse the documentation structure.
* Locate the page or chapter you want to edit.

#### 2. **Click "Edit" in the top-right corner to start a Change Request**

* Use the **visual editor** built into GitBook.

<figure><img src="/files/meuQTLGirQPqptFdGsHi" alt=""><figcaption></figcaption></figure>

#### 3. **Make Your Changes**

* Use headings, bullet points, and code blocks consistently.
* Preview your formatting live in the editor.
* Link to external official resources where helpful.

#### 4. **Leave a Comment (Optional)**

* If you're unsure about a change or want a review, use the comment feature to tag editors or ask a question.

5. **Submit your Change Request for review.**

## Guidelines

* Be clear and beginner-friendly.
* Follow the structure and tone of existing docs.
* Keep Sylius 2.x as the default reference.
* Do not submit edits via GitHub or file uploads – **only edits made through the GitBook UI are accepted**.

## 💬 Need Help?

Join the [Sylius Slack](https://sylius.com/slack), we’re happy to help!


---

# 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 dynamically by asking a question.

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

```
GET https://docs.sylius.com/public/open-source/contributing/contributing-documentation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
