# 文档贡献指北

## 文档贡献流程概览

![文档贡献概览](/files/-M49nCt7Toaq31Az0XqO)

1. **本地修改文档**：在本地修改完文档后，提交对应的PR到RocketMQ-Connect
2. **合并PR**：社区负责人检查无误后，合并到Master分支
3. **自动同步**：通过定时脚本或者GitHub Action触发同步任务

## Markdown语法

本项目采用GitBook做完最终的展示效果，因此项目中Markdown的语法包含两部分：**MarkDown语法**和**GitBook特殊语法**

基本的Markdown语法都是可以支持的。

{% hint style="info" %}
**特别提醒** 请将图片放在 `.gitbook/assets`文件夹下
{% endhint %}

## GitBook特别语法与事例

### SUMMARY文件

SUMMARY文件是文档的总目录，如果我们进行了目录的增删改查，请修改对应的目录项

![目录与代码展示](/files/-M49nCt9-4JwHS_YLVaa)

### 提示效果

```
{% hint style="success" %}
 中间文字
{\% endhint %}
```

![提示效果](/files/-M49nCtBk6RUUgXoWWwJ)

### 副标题

![副标题](/files/-M49nCtD9JwzCVmcKI61)


---

# 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://rocketmq-1.gitbook.io/rocketmq-connector/gong-xian-zhe-zhi-bei/wen-dang-gong-xian-shuo-ming.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.