Submitting Documentation Updates

Follow these steps to contribute to any open-source Kizen docs.

1

Open the documentation page

• Go to the developer.kizen.com page you want to improve.

• Click Edit on GitHub.

2

Fork the repository

• On GitHub, select Fork.

Note: Forking the repository creates your own copy to edit.

3

Create a new branch

In your fork, type the following into your CLI:

git checkout -b update-docs-[short-description]

Example: update-docs-fix-webhook-example

4

Make your changes

• Edit the Markdown file GitHub opened. Make sure to keep the change focused and match existing formatting, tone, and style.

5

Commit your update

Use a clear commit message, for example:

git commit -m "Clarified webhook payload example and fixed query parameters"

6

Push your branch

git push origin update-docs-[short-description]

7

Open a Pull Request

In GitHub, select Compare & Pull Request.

Add a short summary to explain why the change is needed, and provide a link to the doc page.

Note: If you changed formatting on the page, please include before/after screenshots.

Once submitted, the PR enters Kizen’s review workflow.

Related Topics

• Introduction

• Intended Audience

• Contributing to Kizen Docs

• Pull Request Review and Publishing Process