# How to Submit a GitHub Pull Request (PR) for Akinon Documentation

To contribute to Akinon’s documentation, follow these steps to create a Pull Request (PR) and submit your changes:

{% stepper %}
{% step %}
**Go to the Akinon Documentation Repository**

* Visit the [Akinon Docs GitHub repository](https://github.com/akinon/docs).

<figure><img src="/files/KUOI6PivkNwZb9HbGFec" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Find the File You Want to Edit

* Browse through the repository and locate the file that you wish to edit.
* You can either navigate directly to the file through the folder structure or use the search bar at the top of the repository to find it.

<figure><img src="/files/3ShBYLp7psG5tFnBuvCT" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Make Your Changes

* Click on the **pencil icon** (✏️) to edit the file.

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

* Make the necessary changes or updates to the documentation.
* Once you’ve made your edits, click the **Commit changes...** button.

<figure><img src="/files/fmZG3e2UZO0WtKPGJgQV" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Commit the Changes

In the Commit changes section:

* Enter a short, descriptive **Commit message** for your changes (e.g., "Update product setup instructions").
* Add a more detailed description of your changes in the second box under **Extended description**.
* Select **Create a new branch for this commit and start a pull request**.
* Enter a name for your new branch.
* Click on **Propose changes** to commit the changes to the new branch.

<figure><img src="/files/QFeoNNkxbXP41iT8Pswp" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Create a Pull Request (PR)

* After proposing the changes, GitHub will prompt you to create a Pull Request.
* Add a title and description for the PR, explaining what changes you made and why.

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

* Add reviewers: Make sure to add technical writers (**gozdeayber** and **ilaydaocalan**) as reviewers.

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

* Click on **Create pull request** to submit the PR.
  {% endstep %}

{% step %}

#### Review and Merge

Once the technical writers reviews your PR, they will merge it into the main branch.
{% endstep %}
{% endstepper %}


---

# Agent Instructions: 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:

```
GET https://apidocs.akinon.com/how-to-submit-a-github-pull-request-pr-for-akinon-documentation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
