Merge pull request #2372 from getappmap/next-doc

Next doc

Author: kgilpin

docs/appmap-docs.md

@@ -18,7 +18,7 @@ By using AppMap data, Navie is the first AI code architect with the context to u
 
 Over 90,000 software developers are using the [AppMap extension for VSCode](https://marketplace.visualstudio.com/items?itemName=appland.appmap) and the [AppMap plugin for JetBrains](https://plugins.jetbrains.com/plugin/16701-appmap).
 
-<a class="btn btn-primary btn-lg" href="/docs/get-started-with-appmap/">Get Started</a>
+<a class="btn btn-primary btn-lg" href="/docs/get-started-with-appmap/">Get Started</a> <a class="btn btn-secondary btn-lg" href="/docs/troubleshooting/">Troubleshooting</a>
 
 ![AppMap Navie with Sequence diagram in Visual Studio Code](/assets/img/docs/vscode-with-navie-prompt.webp)
 _AppMap Navie with Sequence diagram in Visual Studio Code_

docs/get-started-with-appmap/navie-ai-quickstart.md

@@ -18,67 +18,87 @@ redirect_from: [/docs/setup-appmap-in-your-code-editor/navie-ai-quickstart]
 
 ## Choose your AI Provider (Optional)
 
-By default, Navie uses an AppMap proxy of the latest OpenAI supported AI models. If you would like to customize your own model, you can leverage a variety of other AI model providers such as [Azure OpenAI](https://appmap.io/docs/navie-reference#azure-openai), [Fireworks.ai](https://appmap.io/docs/navie-reference#fireworks-ai), [LM Studio](https://appmap.io/docs/navie-reference#lm-studio), and more.  
+By default, Navie uses the GitHub Copilot LLM.
 
-If you have an active GitHub Copilot subscription, you can use Navie with the [Copilot Language Model](/docs/navie-reference/navie-bring-your-own-model-examples.html#github-copilot-language-model) as a supported backend. Refer to the [Navie Copilot documentation](/docs/navie-reference/navie-bring-your-own-model-examples.html#github-copilot-language-model) for instructions on how to enable.
+If you aren't using Copilot, or if you would like to use your own LLM API key or local LLM, you can use a variety of other AI model providers such as OpenAI, Anthropic, Gemini, Fireworks.ai, LM Studio, and more. View the
+instructions for [Choosing an LLM Provider](/docs/using-navie-ai/choose-llm-provider) for more details.
 
 ## Open AppMap Navie AI
 
-After you complete the installation of AppMap for your code editor. Open the Navie Chat Window to ask Navie about your application. 
+After you complete the installation of AppMap for your code editor. Open the Navie Chat Window to ask Navie about your application.
 
 To open the Navie Chat, open the AppMap plugin in the sidebar menu for your code editor, and select the `New Navie Chat` option.
 
-![Open Navie](/assets/img/open-navie.webp)
+![Open Navie](/assets/img/open-navie.png)
 
 ## Ask Navie about your App
 
 You can ask questions about your application with Navie immediately after installing the plugin. Navie will answer questions based on analysis of your project code. For increased accuracy of more complex projects, you can record AppMap data and Navie will utilize this information as well.
 
-By default, Navie will utilize an OpenAI service hosted by AppMap. If, for data privacy or other reasons, you are do not wish to use the AppMap OpenAI proxy, you can [bring your own OpenAI API key](/docs/using-navie-ai/bring-your-own-model.html#bring-your-own-openai-api-key-byok), or use an [entirely different AI Model](/docs/using-navie-ai/bring-your-own-model.html#ollama), hosted in your environment or hosted locally.
-
-When you ask a question to Navie, it will search through all the available AppMap data for your project to pull in relevant traces, sequence diagrams, and code snippets for analysis. it will send the selected context to your preferred LLM provider.
+When you ask a question to Navie, it will search through all the available AppMap data for your project to pull in relevant traces, sequence diagrams, and code snippets for analysis. It will send the selected context to your preferred LLM provider.
 
 To achieve the highest quality results, we suggest using the available command modes when prompting Navie. Simply type `@` into the chat input to access the list of available command modes.
 
-By default, Navie chat is in a default mode called `@explain`. Other specialized modes are available for generating diagrams, planning work, generating code and tests, and more. Consult [Using Navie docs](/docs/navie-reference/navie-commands.html) for more details on Navie commands.
+By default, Navie chat is in a default mode called `@explain`. Other specialized modes are available for generating diagrams, planning work, generating code and tests, and more. Consult [Navie commands documentation](/docs/using-navie-ai/navie-commands.html) for more details.
+
+The Navie UI includes a standard chat window, and a context panel which will include all the context that is included in the query to the AI provider. This context can include things such as:
 
-The Navie UI includes a standard chat window, and a context panel which will include all the context that is included in the query to the AI provider.  This context can include things such as:
+**Always available:**
 
-**Always available:**  
 - Code Snippets
 - Pinned Content
 
 <p class="alert alert-warning"><b>Note:</b> Only code files and other files that are tracked by Git will be included as context and sent to the LLM when you ask a question. AppMap Navie will respect your <code>.gitignore</code> and will not access files which are not tracked or ignored by Git (such as passwords or sensitive data).</p>
 
-**If AppMap Data exists:**  
+**If AppMap Data exists:**
+
 - Sequence Diagrams
 - HTTP Requests
 - SQL Queries
 - Other I/O Data
 
-**Navie will look for the files listed above in the following locations:**  
+**Navie will look for the files listed above in the following locations:**
+
 - The currently open project
 - All workspace folders in Visual Studio Code
 - All modules available in JetBrains IDEs
 
 ![Navie Context Window](/assets/img/navie-context-window.webp)
 
+## Review Your Code
+
+You can also use Navie to review your code. This is a great way to get an overview of your codebase, identify potential issues, and improve the quality of your code.
+Navie uses the same types of data to perform code review as it does for answering questions, including code snippets, sequence diagrams, traces, and other I/O data.
+
+To start a code review, click the `Review Your Code` button in the Navie sidebar. This will generate a list of suggested improvements for your codebase, including:
+
+![Review Your Code](/assets/img/review_your_code_button.png)
+
+- Potential bugs
+- SQL query optimizations
+- HTTP request optimizations
+- Security vulnerabilities
+- Performance improvements
+- Code design improvements and anti-patterns
+
+... and more. Because Navie uses AppMap Data, it can provide more accurate and relevant suggestions than other code review tools.
+
 ## Improve Navie AI Responses with AppMap Data
 
-Generate AppMap Data and you will greatly improve the quality of your Navie AI responses. With AppMap Data for your project, you can now ask much deeper architectural questions about your application. This is possible because of the additional context from AppMap Data and the higher accuracy and relevance of the code snippets which are relevant to your question. 
+Generate AppMap Data and you will greatly improve the quality of your Navie AI responses. With AppMap Data for your project, you can now ask much deeper architectural questions about your application. This is possible because of the additional context from AppMap Data and the higher accuracy and relevance of the code snippets which are relevant to your question.
 
 View the [Navie AI examples page](/product/examples/navie) to see some examples of Navie fixing complex architectural issues, performance issues, and adding new features to your application.
 
-After your AppMap Data is generated, the Navie window will indicate the AppMap Data that exists for your project. 
+After your AppMap Data is generated, the Navie window will indicate the AppMap Data that exists for your project.
 
 ![Navie AppMap Data Exists](/assets/img/navie-appmap-data-exists.webp)
 
-With this AppMap Data in your project, asking questions to Navie will now include data flows, sequence diagrams, traces, in addition to the relevant code snippets for the project. 
+With this AppMap Data in your project, asking questions to Navie will now include data flows, sequence diagrams, traces, in addition to the relevant code snippets for the project.
 
 ![Navie AppMap context window 2](/assets/img/navie-appmap-context-window.webp)
 
 ## Next Steps
 
-Continue to ask questions to Navie, creating new code for your application, and continue to generate additional AppMap Data as your code changes.  On each subsequent question asked, Navie will re-query your AppMap Data, traces, data flows, and source code for your project to power the context for the answer. 
+Continue to ask questions to Navie, creating new code for your application, and continue to generate additional AppMap Data as your code changes. On each subsequent question asked, Navie will re-query your AppMap Data, traces, data flows, and source code for your project to power the context for the answer.
 
-[Learn more about making AppMap Data to improve Navie response accuracy](/docs/get-started-with-appmap/making-appmap-data)
+[Learn more about making AppMap Data to improve Navie response accuracy](/docs/get-started-with-appmap/making-appmap-data)

docs/navie-reference/navie-options.md

@@ -76,6 +76,7 @@ When enabled, gather will perform any or all of the following actions:
 - List files in the repository.
 - Fetch full the full content of a file in the repository.
 - Search the repository for context by keyword.
+- Fetch the diff between the current working code and the base branch.
 
 Gatherer runs autonomously, there's no user control over what actions it will take. To explicitly
 control the context that's available to Navie, you can other features such as pinned files,
@@ -118,4 +119,54 @@ To include only Python files and exclude files containing the word "test":
 
 ```shell
 @plan /include=\.py /exclude=test
-```
+```
+
+## /diff
+
+The `/diff` option is used to enable or disable the diff feature. This option allows you to control whether Navie should show the difference between the current working code and the base branch.
+
+**Syntax**
+```shell
+/diff
+```
+
+**Description**
+
+While gathering context, Navie will automatically collect the diff between the current working code and the base branch. This feature can help provide more accurate and relevant responses by considering the changes made in the codebase.
+
+The diff information collected uses the git `log` format, so it includes individual commits as well as the commit messages.
+
+The base branch will be determined automatically based on the history. The history is searched for a branch called `main`, `master`, or `develop`. The base branch can be specified manually using the `/base` option.
+
+**Example**
+
+To enable the diff feature, you can use:
+
+```shell
+/diff <question>
+```
+
+## /base
+
+The `/base` option is used to specify the base branch for the diff feature. This option allows you to control which branch Navie should use as the base when showing the difference between the current working code and the base branch.
+
+**Syntax**
+```shell
+/base=<branch-name>
+```
+
+- `<branch-name>`: The name of the branch to be used as the base branch.
+
+**Description**
+
+When executing commands, the `/base` option specifies the base branch for the diff feature. If not specified, the base branch will be determined automatically based on the history. The history is searched for a branch called `main`, `master`, or `develop`.
+
+If you specify the `/base` option, then `/diff` option is automatically enabled.
+
+**Example**
+
+To specify the base branch as `work`, you can use:
+
+```shell
+@generate /base=work <question>
+```