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 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.

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
Plugin Documentation	Join Plugin Docs
Sylius Stack	Join Sylius Stack Docs
FrontWing	Join FrontWing Docs

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.

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.

1. 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, we’re happy to help!