# Contributing

> How you can help make Vaadin better in many ways.

Parent index: [Vaadin Docs](https://vaadin.com/docs/latest/llms.txt)

## Overview

- [Contributing](https://vaadin.com/docs/latest/contributing.md): How you can help make Vaadin better in many ways.

## Editor Settings

- [Editor Settings](https://vaadin.com/docs/latest/contributing/editor-settings.md): How to organize your development environment for Vaadin documentation contributions.

## Pull Requests

- [Pull Requests](https://vaadin.com/docs/latest/contributing/pr.md): How to contribute code to Vaadin projects with GitHub pull requests.

## Creating Tests

- [Creating Tests](https://vaadin.com/docs/latest/contributing/tests.md): How to create tests for code contributions to ensure changes and additions work properly.

## Documentation

- [Documentation](https://vaadin.com/docs/latest/contributing/docs.md): Instructions and guidelines for contributing to the official Vaadin documentation -- this website.
- [Types of Documentation](https://vaadin.com/docs/latest/contributing/docs/types.md): Learn about the different types of Vaadin documentation - how-to guides, reference manuals, and deep dives - and understand best practices for writing each type effectively.
- [Vale](https://vaadin.com/docs/latest/contributing/docs/vale.md): Vale helps contributors to follow the writing style rules and guidelines that are specific to the Vaadin and Hilla documentation.
- [Style Guide](https://vaadin.com/docs/latest/contributing/docs/styleguide.md): Writing style guidelines for documentation writers.
- [Word List](https://vaadin.com/docs/latest/contributing/docs/word-list.md): List of words and phrases to avoid, and word usage advice for the Vaadin documentation.
- [Design System Publisher](https://vaadin.com/docs/latest/contributing/docs/dspublisher.md)
  - [Getting Started](https://vaadin.com/docs/latest/contributing/docs/dspublisher/start.md): Set up your own design system documentation project using Design System Publisher.
  - [Development Server](https://vaadin.com/docs/latest/contributing/docs/dspublisher/devmode.md): When you edit the pages of your documentation website, you run the Design System Publisher development server locally to to see the resulting website as you edit the content.
  - [Site Content](https://vaadin.com/docs/latest/contributing/docs/dspublisher/editing.md): The page hierarchy of the documentation website is defined by the folder structure of files written using the AsciiDoc markup language. Learn how to write these documentation pages.
  - [Configuration](https://vaadin.com/docs/latest/contributing/docs/dspublisher/configuration.md): Various aspects of the documentation website can be configured through environment variables or with a JSON configuration file.
  - [Production Setup](https://vaadin.com/docs/latest/contributing/docs/dspublisher/production.md): Once you're happy with the content and appearance of your design system documentation site, it's time to build for production deployment.
  - [Troubleshooting](https://vaadin.com/docs/latest/contributing/docs/dspublisher/troubleshooting.md): This page describes issues you might encounter while using Design System Publisher.