Fix broken README links (microsoft#49)

- fixes broken README links - closes Issue microsoft#48
mluker · Sep 16, 2024 · f6df131 · f6df131
2 parents f015276 + 30d4cbe
commit f6df131
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -45,7 +45,7 @@ In fact, when considering Rate Limits and Latency, these might be things that yo
 
 By using the Azure OpenAI API Simulator, instead of the live OpenAI API, you can reduce the cost of running load tests against the OpenAI API and ensure that your application behaves as expected under different conditions.
 
-The `Azure OpenAI API Simulator presents the same interface as the live OpenAI API, allowing you to easily switch between the two, and then gives you full control over the responses that are returned.
+The Azure OpenAI API Simulator presents the same interface as the live OpenAI API, allowing you to easily switch between the two, and then gives you full control over the responses that are returned.
 
 ### Simulator Modes
 
@@ -93,7 +93,7 @@ The behaviour of the Azure OpenAI API Simulator is controlled via a range of [Az
 
 ### Extending the Azure OpenAI API Simulator
 
-There are also a number of [Azure OpenAI API Simulator Extension points](./docs/extensions.md) that allow you to customise the behaviour of the Azure OpenAI API Simulator. Extensions can be used to modify the request/response, add latency, or even generate responses.
+There are also a number of [Azure OpenAI API Simulator Extension points](./docs/extending.md) that allow you to customise the behaviour of the Azure OpenAI API Simulator. Extensions can be used to modify the request/response, add latency, or even generate responses.
 
 ### Contributing to the Azure OpenAI API Simulator
 

diff --git a/docs/extending.md b/docs/extending.md
@@ -14,7 +14,7 @@ The simulator allows extending some aspects of the behavior without modifying th
 An extension can be either a single python file or a package folder.
 The extension should contain an `initialize` method that receives the simulator configuration and can modify it.
 
-The `initialize` method in an extension is psased the simulator configuration object.
+The `initialize` method in an extension is passed the simulator configuration object.
 Through this an extension can add/remove forwarders, generators, and limiters, as well as modifying other aspects of the configuration.
 
 NOTE: the `initialize` method may be called multiple times, so ensure that any configuration changes are idempotent.

diff --git a/docs/running-deploying.md b/docs/running-deploying.md
@@ -28,7 +28,7 @@ make install-requirements
 
 ## Running the Simulator Locally
 
-Before running the Azure OpenAI API Simulator you should ensure that you have set up your local config. See [Azure OpenAI API Simulator Configuration Options](./docs/config.md) for details on how to do this.
+Before running the Azure OpenAI API Simulator you should ensure that you have set up your local config. See [Azure OpenAI API Simulator Configuration Options](./config.md) for details on how to do this.
 
 To run the simulated API, use the following command from the repository root directory:
 
@@ -61,7 +61,7 @@ SIMULATOR_MODE=generate make run-simulated-api
 
 The simulated API can be deployed to Azure Container Apps (ACA) to provide a publicly accessible endpoint for testing with the rest of your system.
 
-Before deploying, set up a `.env` file. See [Azure OpenAI API Simulator Configuration Options](./docs/config.md) for details on how to do this.
+Before deploying, set up a `.env` file. See [Azure OpenAI API Simulator Configuration Options](./config.md) for details on how to do this.
 
 Once you have your `.env` file, you can deploy to Azure using the following command:
 
@@ -156,7 +156,7 @@ The restricted network access scenario applies when both the build machine and t
 
 In this scenario, the simulator can be built using a pre-downloaded TikToken encoding file that must be included in a specific location.
 
-This can be done by running the [setup_tiktoken.py](./scripts/setup_tiktoken.py) script.
+This can be done by running the [setup_tiktoken.py](../scripts/setup_tiktoken.py) script.
 
 Alternatively, you can download the [encoding file](https://openaipublic.blob.core.windows.net/encodings/cl100k_base.tiktoken) from the public blob storage account and place it in the `src/aoai-api-simulator/tiktoken_cache` directory. Then rename the file to `9b5ad71b2ce5302211f9c61530b329a4922fc6a4`.