diff --git a/docs/docs/tools/ask.md b/docs/docs/tools/ask.md index 79c4f00f..f7678337 100644 --- a/docs/docs/tools/ask.md +++ b/docs/docs/tools/ask.md @@ -22,7 +22,7 @@ You can run `/ask` on specific lines of code in the PR from the PR's diff view. Note that the tool does not have "memory" of previous questions, and answers each question independently. -## Ask on images (using the PR code as context) +## Ask on images You can also ask questions about images that appear in the comment, where the entire PR is considered as the context. The tool will answer questions based on the images in the PR. The basic syntax is: @@ -34,6 +34,7 @@ The basic syntax is: Note that GitHub has a mecahnism of pasting images in comments. However, pasted image does not provide a direct link. To get a direct link to the image, we recommend using the following steps: + 1) send a comment that contains only the image: ![Ask image1](https://codium.ai/images/pr_agent/ask_images1.png){width=512} @@ -45,8 +46,11 @@ To get a direct link to the image, we recommend using the following steps: 3) type the question below the image: ![Ask image3](https://codium.ai/images/pr_agent/ask_images3.png){width=512} -![Ask image4](https://codium.ai/images/pr_agent/ask_images3.png){width=512} +![Ask image4](https://codium.ai/images/pr_agent/ask_images4.png){width=512} 4) post the comment, and receive the answer: -![Ask image5](https://codium.ai/images/pr_agent/ask_images5.png){width=512} \ No newline at end of file +![Ask image5](https://codium.ai/images/pr_agent/ask_images5.png){width=512} + + +See a full video tutorial [here](https://codium.ai/images/pr_agent/ask_image_video.mov) \ No newline at end of file