From 85f64ad8950386e7fa36a6452ba05016abe9bb64 Mon Sep 17 00:00:00 2001 From: "Hussam.lawen" Date: Mon, 2 Oct 2023 10:11:28 +0300 Subject: [PATCH] update readme and user guide --- README.md | 2 +- docs/ADD_DOCUMENTATION.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 12990189..81a343c5 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull \ ‣ **Find similar issue ([`/similar_issue`](./docs/SIMILAR_ISSUE.md))**: Automatically retrieves and presents similar issues \ -‣ **Add Documentation (`/add_docs`)**: Automatically adds [documentation](https://github.com/Codium-ai/pr-agent/pull/337#discussion_r1342111682) to un-documented functions/classes in the PR. +‣ **Add Documentation (`/add_docs`)**: Automatically adds [documentation](./docs/ADD_DOCUMENTATION.md) to un-documented functions/classes in the PR. See the [Usage Guide](./Usage.md) for instructions how to run the different tools from _CLI_, _online usage_, Or by _automatically triggering_ them when a new PR is opened. diff --git a/docs/ADD_DOCUMENTATION.md b/docs/ADD_DOCUMENTATION.md index 333352e8..b7204f80 100644 --- a/docs/ADD_DOCUMENTATION.md +++ b/docs/ADD_DOCUMENTATION.md @@ -6,6 +6,7 @@ It can be invoked manually by commenting on any PR: /add_docs ``` For example: +