# Creating Diagrams

## Context

Creating editable diagrams in open formats using open source tools is challenging. Here, we suggest [Draw.io](https://app.diagrams.net/) for creating diagrams and saving them directly in GitHub repository.

## Creating new diagram

1. On [Draw.io](https://app.diagrams.net/) website choose *Device* as your storage.

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

2. Select the format of the diagram as XML`.drawio.`

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

3. Create the diagram and save it on your local machine. Make sure you follow the file naming convention of lowercase with hyphens as word separations.
4. Fork `openg2p-documentation` repository to your Github account.
5. Disable workflow in your repository fork:

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

6. On Github, upload/commit the `.drawio` file to **your fork** of `openg2p-documentation` repository in the branch of choice to the following folder: `.gitbook/assets`.
7. Send a Pull Request.
8. After the PR is merged on the upstream repo a [Gitbook Action Workflow](https://github.com/OpenG2P/openg2p-documentation/blob/1.1/.github/workflows/drawio.yml) will get triggered to convert the same to PNG format with `*.png` extension. The PNG file will be available in the same folder as the `.drawio` file. In this case, it will be the repository's `.gitbook/assets` folder.
9. On Gitbook, insert the PNG image using the *URL* options shown by Gitbook. The URL to be given will be the GitHub URL e.g. <https://github.com/OpenG2P/openg2p-documentation/raw/1.1/.gitbook/assets/add-deduplication-manager.png>. Make sure you pick this URL in **Raw** format which will be available on the *Download* button on Github

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

## Editing existing diagram

If a `.drawio` already exists in the `.gitbook/assets` folder then you must directly edit the repository version of the same by following the procedure given below.

1. Fork the `openg2p-documentation` repository to your local Github account. Disable workflow as shown above.
2. On the [Draw.io](https://app.diagrams.net/) website choose Github as your storage.

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

3. Authorize the Draw\.io app on Github (follow the steps prompted).
4. Select the diagram in `.drawio` format from `openg2p-documentation` --> your branch --> `.gitbook/assests` folder.

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

5. Make changes.
6. Save the diagram - it will get Git-committed to your repository.
7. Send a Pull Request to `OpenG2P/openg2p-documentation` repo.
8. Upon acceptance of the Pull Request, a [Github Action Workflow](https://github.com/OpenG2P/openg2p-documentation/blob/1.1/.github/workflows/drawio.yml) will trigger the conversion of the`.drawio` file to `.png`.
9. If you have not added the URL of the PNG to your Gitbook pages follow step 6 of [Creating New Diagram](#creating-new-diagram).
10. If the URL already exists in Gitbook, the updated image should appear after a page refresh.

## Deleting a digram

1. Delete the diagram from Gitbook listing found here:

<div align="center"><figure><img src="/files/MTSc5wkrMpi1OXuIQw7G" alt="" width="256"><figcaption></figcaption></figure></div>

2. Delete the diagram from Github repository `openg2p-documentation` from the corresponding branch


---

# 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://docs.openg2p.org/1.1/guides/documentation-guides/creating-diagrams.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.