feat: Sync docs from applandinc.appmap.io (#2026)

kgilpin · petecheslock · dustinbyrne · commit d97e87494daf · 2024-10-07T06:24:44.000-07:00
Co-authored-by: petecheslock &lt;511733+petecheslock@users.noreply.github.com&gt;
diff --git a/docs/get-started-with-appmap/navie-ai-quickstart.md b/docs/get-started-with-appmap/navie-ai-quickstart.md
@@ -20,7 +20,7 @@ redirect_from: [/docs/setup-appmap-in-your-code-editor/navie-ai-quickstart]
 
 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.  
 
-If you have an active GitHub Copilot subscription, you can use Navie with the [Copilot Lanauage 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 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.
 
 ## Open AppMap Navie AI
 
diff --git a/docs/navie-reference/navie-github-repository.md b/docs/navie-reference/navie-github-repository.md
@@ -2,7 +2,7 @@
 layout: docs
 title: Docs - AppMap Navie
 description: "Reference Guide to AppMap Navie AI, a link to the code repository for AppMap Navie AI."
-name: Github Repository
+name: GitHub Repository
 navie-reference: true
 step: 8
 ---
diff --git a/docs/reference/appmap-airgapped-install.md b/docs/reference/appmap-airgapped-install.md
@@ -274,11 +274,11 @@ After completing the install steps, you can confirm the installation was done co
 ### Open a Navie Chat 
 
 Follow the [getting started instructions](/docs/using-navie-ai/how-to-open-navie) to open a new Navie chat window.  
-If the AppMap binaries are installed and executable, you should see a new Navie chat window open sucessfully. 
+If the AppMap binaries are installed and executable, you should see a new Navie chat window open successfully. 
 
 <img class="video-screenshot" src="/assets/img/docs/offline-install-14.webp"/>
 
-If the binaries are not installed in the correct location, or are not exectuable, you will show a new Navie window prompt attempting to open but will hang until timeout. 
+If the binaries are not installed in the correct location, or are not executable, you will show a new Navie window prompt attempting to open but will hang until timeout. 
 
 <img class="video-screenshot" src="/assets/img/docs/offline-install-15.webp"/>
 
diff --git a/docs/reference/appmap-client-cli.md b/docs/reference/appmap-client-cli.md
@@ -455,7 +455,7 @@ using the `--filter` option. Here are the steps for using this technique:
 
 1. Open an AppMap in the code editor.
 2. Use the filtering available in the AppMap to hide certain events. ![AppMap Filtering](/assets/img/docs/using_appmap_filter.jpg)
-3. Open the command pallette using `CTRL+SHIFT+P` or `COMMAND+SHIFT+P` on macOS, type `AppMap: Copy Current AppMap State to Clipboard`, then hit `Enter`.
+3. Open the command palette using `CTRL+SHIFT+P` or `COMMAND+SHIFT+P` on macOS, type `AppMap: Copy Current AppMap State to Clipboard`, then hit `Enter`.
 4. Use the copied state as the `--filter` argument to the `prune` command. The `prune` command will remove whatever was filtered in the AppMap in your code editor.
 
 ```shell
diff --git a/docs/reference/appmap-java.md b/docs/reference/appmap-java.md
@@ -218,7 +218,7 @@ attribute is ignored.
 The `appmap-java` annotations are provided in the package `com.appland:appmap-annotation`, available on [Maven Central](https://search.maven.org/artifact/com.appland/appmap-annotation). To use them, add that package as a dependency in your build configuration file (`pom.xml`, `build.gradle`).
 
 ### @Labels
-`appmap-java` suports the addition of [code labels](/docs/reference/appmap-java.html#annotations) through the `com.appland.appmap.annotation.Labels` annotation.
+`appmap-java` supports the addition of [code labels](/docs/reference/appmap-java.html#annotations) through the `com.appland.appmap.annotation.Labels` annotation.
 
 #### Usage
 Once the `Labels` annotation is available, you can apply it to methods in your application. For example:
diff --git a/docs/reference/guides/navigating-code-objects.md b/docs/reference/guides/navigating-code-objects.md
@@ -36,7 +36,7 @@ There are three sections to the Code Objects view. The first section is the Code
 
 In the HTTP Service request list, you can see basically a mini spec file showing you what routes are available across all of your AppMap Diagrams. 
 
-If this route only exists in a single AppMap, you’ll be taken directly to the AppMap for this request, but if the route exists in multiple diagrams you’ll get a VScode picker to choose which one to open. 
+If this route only exists in a single AppMap, you’ll be taken directly to the AppMap for this request, but if the route exists in multiple diagrams you’ll get a VSCode picker to choose which one to open. 
 
 Here is this route, and here it is shown in a trace view, and you’ll see the status code for that is 302 which is a redirect.
 
diff --git a/docs/reference/guides/using-appmap-diagrams.md b/docs/reference/guides/using-appmap-diagrams.md
@@ -264,7 +264,7 @@ Flame Graphs make it easy to see how much time is spent in each function, and wh
 
 ### How to read a Flame Graph
 
-The lowest layer in a Flame Graph represents the AppMap Data recording, and it contains the recordings’s name. For an AppMap Flame Graph created from tests, this will usually be the same name as the test from which it was generated. In the example below, the AppMap was recorded from a test related to an application’s account activation capability.
+The lowest layer in a Flame Graph represents the AppMap Data recording, and it contains the recording's name. For an AppMap Flame Graph created from tests, this will usually be the same name as the test from which it was generated. In the example below, the AppMap was recorded from a test related to an application’s account activation capability.
 
 ![flame graph image](/assets/img/docs/flamegraph-8.webp)
 
diff --git a/docs/reference/integrations/smartbear-swaggerhub.md b/docs/reference/integrations/smartbear-swaggerhub.md
@@ -115,6 +115,6 @@ env:
 
 Refer to [this project on GitHub](https://github.com/land-of-apps/rails_tutorial_sample_app_7th_ed/blob/smartbear-api-comparison/.github/workflows/openapi-compare.yml) for a fully working example of this GitHub Action.
 
-With this configuratino enabled, when a user makes a commit which changes the routes that are NOT currently in the published API spec on SwaggerHub this build will fail and the user will be unable to deploy unless they update the API spec on SwaggerHub or remove the offending changes. 
+With this configuration enabled, when a user makes a commit which changes the routes that are NOT currently in the published API spec on SwaggerHub this build will fail and the user will be unable to deploy unless they update the API spec on SwaggerHub or remove the offending changes. 
 
 <img class="video-screenshot" src="/assets/img/swaggerhub-github-build-failure.webp"/>
diff --git a/docs/reference/vscode.md b/docs/reference/vscode.md
@@ -121,7 +121,7 @@ Learn more about AppMap in GitHub Codespaces:
 
 ## Generate OpenAPI Definitions
 
-After [recording AppMap Data](/docs/recording-methods.html) for your project, open the command pallette using `CTRL+SHIFT+P` or `COMMAND+SHIFT+P` on macOS, type `AppMap: Generate OpenAPI`, then hit `Enter`. This will open a new file with your OpenAPI definition document. Save this file locally, share with your team, or ingest as a [new collection into API tools like Postman.](https://blog.postman.com/new-postman-integration-with-appmap-create-and-manage-always-accurate-collections/)
+After [recording AppMap Data](/docs/recording-methods.html) for your project, open the command palette using `CTRL+SHIFT+P` or `COMMAND+SHIFT+P` on macOS, type `AppMap: Generate OpenAPI`, then hit `Enter`. This will open a new file with your OpenAPI definition document. Save this file locally, share with your team, or ingest as a [new collection into API tools like Postman.](https://blog.postman.com/new-postman-integration-with-appmap-create-and-manage-always-accurate-collections/)
 
 ![alt_text](/assets/img/openapi/openapi-1.webp "OpenAPI export to file")
 
diff --git a/docs/using-navie-ai/bring-your-own-model.md b/docs/using-navie-ai/bring-your-own-model.md
@@ -82,7 +82,7 @@ After your code editor reloads, you can confirm your requests are being routed t
 
 AppMap generally uses the latest OpenAI models as the default, but if you want to use an alternative model like `gpt-3.5` or a preview model like `gpt-4-vision-preview` you can modify the `APPMAP_NAVIE_MODEL` environment variable after configuring your own OpenAI API key to use other OpenAI models.  
 
-After setting your `APPMAP_NAVIE_MODEL` with your chosen model reload/restart your code editor and then confirm it's configuration by opening a new Navie chat window. In this example i've configured my model to be `gpt-4o` with my personal OpenAI API Key. 
+After setting your `APPMAP_NAVIE_MODEL` with your chosen model reload/restart your code editor and then confirm it's configuration by opening a new Navie chat window. In this example I've configured my model to be `gpt-4o` with my personal OpenAI API Key. 
 
 ![JetBrains OpenAI key modal](/assets/img/product/custom-model.webp)
 
diff --git a/docs/using-navie-ai/how-to-open-navie.md b/docs/using-navie-ai/how-to-open-navie.md
@@ -19,7 +19,7 @@ redirect_from: [/docs/using-navie-ai/using-navie.html#how-to-open-navie, /docs/n
 
 ### In the VS Code Sidebar <!-- omit in toc -->
 
-You can open Navie in the VC Code sidebar by expanding (if necessary) the Navie section and select the `New Navie Chat` button. 
+You can open Navie in the VSCode sidebar by expanding (if necessary) the Navie section and select the `New Navie Chat` button. 
 
 <img class="video-screenshot" src="/assets/img/product/navie-sidebar.webp"/> 
 
