Fix broken links

hemang1729 · hemang1729 · commit 0cf5e5725e0b · 2025-02-24T12:02:11.000+01:00
diff --git a/docs/explorer/api/annotations.md b/docs/explorer/api/annotations.md
@@ -16,7 +16,7 @@ Annotations provide additional context, facilitating collaboration and agent err
 
 ## Annotation Format
 
-You can add annotations to traces at upload time. For this, both during [file upload](./Uploading_Traces/file_uploads.md) and via the [Push API](./Uploading_Traces/push_api.md), you can include an `annotations` field in the trace data. This field should be an array of objects, each representing an annotation. Each annotation object should have the following fields:
+You can add annotations to traces at upload time. For this, both during [file upload](../uploading-traces/file-uploads) and via the [Push API](../uploading-traces/push-api), you can include an `annotations` field in the trace data. This field should be an array of objects, each representing an annotation. Each annotation object should have the following fields:
 
 ##### `content` <span class='type'>string</span> <span class='required'/>
 
diff --git a/docs/explorer/api/uploading-traces/file-uploads.md b/docs/explorer/api/uploading-traces/file-uploads.md
@@ -20,7 +20,7 @@ The explorer supports two types of trace formats: _raw event lists_ and _annotat
 
 #### Raw Event Lists
 
-Raw event lists are `jsonl` files where each line is a JSON array of events. Each event is a dictionary with at least a `role` and `content` field according to the trace format described [in this chapter](../2_traces.md).
+Raw event lists are `jsonl` files where each line is a JSON array of events. Each event is a dictionary with at least a `role` and `content` field according to the trace format described [in this chapter](../../trace-format).
 
 ```json
 [{ "role": "user", "content": "Hello, world!" }, { "role": "assistant", "content": "Hi!" }]
@@ -36,7 +36,7 @@ To include trace-level metadata in raw event lists, include a metadata JSON obje
 
 #### Annotated Event Lists
 
-Annotated event lists support the same format as raw event lists, but also include [annotations](../3_annotations.md). 
+Annotated event lists support the same format as raw event lists, but also include [annotations](../../annotations). 
 
 For this, each line is a JSON object with the fields `messages`, `annotations` (optional) and `metadata` (optional, for trace-level metadata).
 
diff --git a/docs/explorer/api/uploading-traces/push-api.md b/docs/explorer/api/uploading-traces/push-api.md
@@ -24,7 +24,7 @@ The `PushTracesRequest` class holds the request data for a trace upload request.
 
 This represents the traces in a dataset. Each `List[Dict]` is a single trace within the dataset. Each `dict` is a single message within a trace - these can represet a user prompt, a tool call, a tool output, etc.
 
-Must be in the [required trace format](../2_traces.md). Must not be empty.
+Must be in the [required trace format](../../trace-format). Must not be empty.
 
 ##### `annotations` <span class='type'>Optional[List[List[AnnotationCreate]]</span> <span class='optional'/>
 
@@ -48,13 +48,13 @@ Must be a list of dictionaries if provided and must be the same length as messag
 
 Each metadata dictionary can have arbitrary keys and values for storing additional information about the trace.
 
-See [File Uploads](../Uploading_Traces/file_uploads.md) for more information on metadata.
+See [File Uploads](../file-uploads) for more information on metadata.
 
 ### `AnnotationCreate`
 
 The `AnnotationCreate` class holds the data for an annotation to be created.
 
-See [Annotations](../3_annotations.md) for more information on annotations.
+See [Annotations](../../annotations) for more information on annotations.
 
 ##### `content` <span class='type'>str</span> <span class='required'/>
 
diff --git a/docs/explorer/benchmarks.md b/docs/explorer/benchmarks.md
@@ -38,7 +38,7 @@ Once you have prepared and ensured that your agent traces are in a compatible fo
 
 ### Step 3: Associate Your Agent Dataset with a Benchmark and Score
 
-[Instructions on updating the datasets's metadata](./Explorer_API/Dataset_Metadata/update_dataset_metadata_api.md) to include the `benchmark`, `name` and `accuracy` fields, that will associate your agent dataset with a specific benchmark and score.
+[Instructions on updating the datasets's metadata](./api/dataset-metadata/update.md) to include the `benchmark`, `name` and `accuracy` fields, that will associate your agent dataset with a specific benchmark and score.
 
 For instance, to associate your `gpt-4o` agent dataset with the `webarena` benchmark and an accuracy score of `0.5`, you can update the dataset's metadata as follows:
 
diff --git a/docs/explorer/index.md b/docs/explorer/index.md
@@ -31,7 +31,7 @@ export INVARIANT_API_KEY=<your-api-key>
 
 ## 3. Install the Invariant SDK
 
-Next, install the Invariant SDK in your Python environment, by running the following command. See [Installation](Explorer_API/installation.md) for alternative methods using different package managers.
+Next, install the Invariant SDK in your Python environment, by running the following command. See [Installation](api/sdk-installation) for alternative methods using different package managers.
 
 ```bash
 pip install invariant-sdk
@@ -78,7 +78,7 @@ client.create_request_and_push_trace(traces, dataset="my-first-dataset")
 
 This will upload your traces to the Invariant Explorer under a new dataset named `my-first-dataset`. If the corresponding dataset already exists, the traces will be appended to it.
 
-To learn more about the expected trace format see the chapter on the [trace format requirements](Explorer_API/2_traces.md).
+To learn more about the expected trace format see the chapter on the [trace format requirements](api/trace-format.md).
 
 ## Work With Your Traces in Explorer
 
diff --git a/docs/explorer/self-hosted.md b/docs/explorer/self-hosted.md
@@ -40,15 +40,15 @@ This will pull and launch the required Explorer Docker containers on your machin
 
 ## Using the Self-Hosted Explorer
 
-The self-hosted version of Explorer is configured to run on `http://localhost`. You can access it in your browser at this address. The local instance provides the same API as the managed cloud instance, so you can use the [Invariant SDK](./Explorer_API/1_client_setup.md) to connect to it.
+The self-hosted version of Explorer is configured to run on `http://localhost`. You can access it in your browser at this address. The local instance provides the same API as the managed cloud instance, so you can use the [Invariant SDK](./api/client-setup) to connect to it.
 
 ### Storage
 
 The self-hosted version of Explorer will create a `data/` directory in the current working directory to store traces and other data.
 
 ### Usage and Access
 
-You can access the self-hosted version of Explorer at `http://localhost`. To use it with the [Invariant SDK](./Explorer_API/1_client_setup.md) you can set the `INVARIANT_API_ENDPOINT` environment variable to `http://localhost/`. For security reasons, you'll still need to create and provide an API key to access the self-hosted version of Explorer.
+You can access the self-hosted version of Explorer at `http://localhost`. To use it with the [Invariant SDK](./api/client-setup) you can set the `INVARIANT_API_ENDPOINT` environment variable to `http://localhost/`. For security reasons, you'll still need to create and provide an API key to access the self-hosted version of Explorer.
 
 ### Updates
 `invariant explorer` will automatically check for updates and pull the latest stable version of the Explorer Docker images. If you want to try the latest development version, you can use the `--version=main` flag. Note however, that database migrations may be required when switching between versions, which may not always be backwards compatible.
diff --git a/docs/testing/index.md b/docs/testing/index.md
@@ -82,11 +82,11 @@ ________________________________________________________________________________
 #     },
 #  ]
 ```
-The test result provides information about which assertion failed but also [localizes the assertion failure precisely](./Writing_Tests/tests.md) in the provided list of agent messages.
+The test result provides information about which assertion failed but also [localizes the assertion failure precisely](writing/tests) in the provided list of agent messages.
 
 **Visual Test Viewer (Explorer):**
 
-As an alternative to the command line, you can also [visualize test results](./Running_Tests/Visual_Debugger.md) on the [Invariant Explorer](https://explorer.invariantlabs.ai/):
+As an alternative to the command line, you can also [visualize test results](running/visual-debugging) on the [Invariant Explorer](https://explorer.invariantlabs.ai/):
 
 ```py
 $ invariant test --push
@@ -98,11 +98,11 @@ Like the terminal output, the Explorer highlights the relevant ranges, but does
 
 ## Features
 
-* Comprehensive [`Trace` API](Writing_Tests/1_Traces.ipynb) for easily navigating and checking agent traces.
-* [Assertions library](Writing_Tests/2_Assertions.md) to check agent behavior, including fuzzy checkers such as _Levenshtein distance_, _semantic similarity_ and _LLM-as-a-judge_ pipelines.
-* Full [`pytest` compatibility](Running_Tests/PyTest_Compatibility.md) for easy integration with existing test and CI/CD pipelines.
-* Parameterized tests for [testing multiple scenarios](Writing_Tests/parameterized-tests) with a single test function.
-* [Visual test viewer](Writing_Tests/4_Visual_Test_Viewer.md) for exploring large traces and debugging test failures.
+* Comprehensive [`Trace` API](writing/traces) for easily navigating and checking agent traces.
+* [Assertions library](writing/matchers) to check agent behavior, including fuzzy checkers such as _Levenshtein distance_, _semantic similarity_ and _LLM-as-a-judge_ pipelines.
+* Full [`pytest` compatibility](running/pytest-compatibility) for easy integration with existing test and CI/CD pipelines.
+* Parameterized tests for [testing multiple scenarios](writing/parameterized-tests) with a single test function.
+* [Visual test viewer](running/visual-debugging) for exploring large traces and debugging test failures.
 
 ## Next Steps
 
diff --git a/docs/testing/running/pytest-compatibility.md b/docs/testing/running/pytest-compatibility.md
@@ -24,7 +24,7 @@ results. This name will be used to derive a fresh dataset name on each run
 --push (optional)
 ```
 
-Flag to indicate whether to [push data to Explorer](./Visual_Debugger.md). If set to true,
+Flag to indicate whether to [push data to Explorer](./visual-debugging.md). If set to true,
 the `INVARIANT_API_KEY` environment variable must be set. Visit the [Explorer Documentation](https://explorer.invariantlabs.ai/docs/explorer) to learn how to obtain your own API key.
 
 ### Example Commands
