
**************
Online Editing
**************

Welcome!
This page explains the process for contributing to Blender's documentation through our online editing workflow.
Whether you're fixing typos or adding entirely new sections, your contributions are valuable.

Below is an overview of the online editing process.


Getting Started
===============

Before contributing, you need an account at `projects.blender.org <https://projects.blender.org/>`__.
Click the "Sign In" button and follow the prompts to create an account if you don't already have one.

Once logged in, you can start editing directly from your browser.


Finding the Page to Edit
========================

Navigate to the Blender Manual (`docs.blender.org/manual <https://docs.blender.org/manual/en/dev/>`__)
and browse to the page you want to improve (make sure you are browsing under the development version (``/dev``)).

At the top-right of every page, you'll find an "Edit Page" link.
Clicking it will take you to the online editor at `projects.blender.org`.


Making Changes
==============

After clicking "Edit this page," you will see the current page source in a text editing area.
Blender's documentation is written using reStructuredText (RST).

You can now:

- Correct typos or grammar issues.
- Add missing details or improve explanations.

.. tip::

   Review the :doc:`Markup Style Guide </contribute/manual/guides/markup_guide>` for help with formatting.


Previewing Your Changes
=======================

Currently, the online editor has limited support for previewing your changes.
To ensure correctness, double-check your formatting and refer to similar existing documentation pages for guidance.


Committing Your Changes
=======================

After making your edits, proceed to the bottom of the page:

- Provide a clear, concise summary of your changes in the commit message box
  (e.g., "Fixed typo in Sculpting documentation").
- Select "Commit Changes".

This action will automatically guide you to create a "Pull Request" to submit your edits for review.


Pull Requests and Reviews
=========================

When you commit your changes, they are sent as a pull request for review by the documentation team.
Reviewers may suggest improvements or request additional changes.

.. important::

   Stay engaged! Watch your email or notifications on `projects.blender.org` to respond promptly to reviewer comments.

Once your pull request is approved, a reviewer will merge it, and your contribution will be published online.


Best Practices
==============

- **Keep edits focused:** One topic per pull request.
- **Clear commit messages:** Make your commit messages specific.
- **Respond promptly:** Active communication makes reviews faster.


Getting Help
============

If you're unsure about a change, formatting, or workflow, don't hesitate to ask questions:

- Join the `Blender Chat #docs <https://chat.blender.org/#/room/#docs:blender.org>`__ channel.
- Open an issue at the `documentation project <https://projects.blender.org/blender/documentation>`__
  for broader discussions or complex questions.

Thank you for helping improve Blender's documentation!
