Skip to content

Commit 7dcd54e

Browse files
committed
Fixing broken links and relative paths.
1 parent 0cf5e57 commit 7dcd54e

File tree

7 files changed

+19
-35
lines changed

7 files changed

+19
-35
lines changed

docs/explorer/api/annotations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Annotations provide additional context, facilitating collaboration and agent err
1616

1717
## Annotation Format
1818

19-
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:
19+
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:
2020

2121
##### `content` <span class='type'>string</span> <span class='required'/>
2222

docs/explorer/api/uploading-traces/file-uploads.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The explorer supports two types of trace formats: _raw event lists_ and _annotat
2020

2121
#### Raw Event Lists
2222

23-
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).
23+
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.md).
2424

2525
```json
2626
[{ "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
3636

3737
#### Annotated Event Lists
3838

39-
Annotated event lists support the same format as raw event lists, but also include [annotations](../../annotations).
39+
Annotated event lists support the same format as raw event lists, but also include [annotations](../annotations.md).
4040

4141
For this, each line is a JSON object with the fields `messages`, `annotations` (optional) and `metadata` (optional, for trace-level metadata).
4242

docs/explorer/api/uploading-traces/push-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The `PushTracesRequest` class holds the request data for a trace upload request.
2424

2525
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.
2626

27-
Must be in the [required trace format](../../trace-format). Must not be empty.
27+
Must be in the [required trace format](../trace-format.md). Must not be empty.
2828

2929
##### `annotations` <span class='type'>Optional[List[List[AnnotationCreate]]</span> <span class='optional'/>
3030

@@ -48,13 +48,13 @@ Must be a list of dictionaries if provided and must be the same length as messag
4848

4949
Each metadata dictionary can have arbitrary keys and values for storing additional information about the trace.
5050

51-
See [File Uploads](../file-uploads) for more information on metadata.
51+
See [File Uploads](file-uploads.md) for more information on metadata.
5252

5353
### `AnnotationCreate`
5454

5555
The `AnnotationCreate` class holds the data for an annotation to be created.
5656

57-
See [Annotations](../../annotations) for more information on annotations.
57+
See [Annotations](../annotations.md) for more information on annotations.
5858

5959
##### `content` <span class='type'>str</span> <span class='required'/>
6060

docs/explorer/self-hosted.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ This will pull and launch the required Explorer Docker containers on your machin
4040

4141
## Using the Self-Hosted Explorer
4242

43-
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.
43+
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.md) to connect to it.
4444

4545
### Storage
4646

4747
The self-hosted version of Explorer will create a `data/` directory in the current working directory to store traces and other data.
4848

4949
### Usage and Access
5050

51-
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.
51+
You can access the self-hosted version of Explorer at `http://localhost`. To use it with the [Invariant SDK](api/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.
5252

5353
### Updates
5454
`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.

docs/testing/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Overview
66

77
Invariant `testing` is a lightweight library to write and run AI agent tests. It provides helpers and assertions that enable you to write robust tests for your agentic applications.
88

9-
Using [**localized assertions**](Writing_Tests/1_Traces.ipynb), `testing` always points you to the exact part of the agent's behavior that caused a test to fail, making it easy to debug and resolve issues (_think: stacktraces for agents_).
9+
Using [**localized assertions**](writing/traces.ipynb), `testing` always points you to the exact part of the agent's behavior that caused a test to fail, making it easy to debug and resolve issues (_think: stacktraces for agents_).
1010

1111

1212
<br/>
@@ -82,11 +82,11 @@ ________________________________________________________________________________
8282
# },
8383
# ]
8484
```
85-
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.
85+
The test result provides information about which assertion failed but also [localizes the assertion failure precisely](writing/tests.md) in the provided list of agent messages.
8686

8787
**Visual Test Viewer (Explorer):**
8888

89-
As an alternative to the command line, you can also [visualize test results](running/visual-debugging) on the [Invariant Explorer](https://explorer.invariantlabs.ai/):
89+
As an alternative to the command line, you can also [visualize test results](running/visual-debugging.md) on the [Invariant Explorer](https://explorer.invariantlabs.ai/):
9090

9191
```py
9292
$ invariant test --push
@@ -98,12 +98,12 @@ Like the terminal output, the Explorer highlights the relevant ranges, but does
9898

9999
## Features
100100

101-
* Comprehensive [`Trace` API](writing/traces) for easily navigating and checking agent traces.
102-
* [Assertions library](writing/matchers) to check agent behavior, including fuzzy checkers such as _Levenshtein distance_, _semantic similarity_ and _LLM-as-a-judge_ pipelines.
103-
* Full [`pytest` compatibility](running/pytest-compatibility) for easy integration with existing test and CI/CD pipelines.
104-
* Parameterized tests for [testing multiple scenarios](writing/parameterized-tests) with a single test function.
105-
* [Visual test viewer](running/visual-debugging) for exploring large traces and debugging test failures.
101+
* Comprehensive [`Trace` API](writing/traces.ipynb) for easily navigating and checking agent traces.
102+
* [Assertions library](writing/matchers.md) to check agent behavior, including fuzzy checkers such as _Levenshtein distance_, _semantic similarity_ and _LLM-as-a-judge_ pipelines.
103+
* Full [`pytest` compatibility](running/pytest-compatibility.md) for easy integration with existing test and CI/CD pipelines.
104+
* Parameterized tests for [testing multiple scenarios](writing/parameterized-tests.md) with a single test function.
105+
* [Visual test viewer](running/visual-debugging.md) for exploring large traces and debugging test failures.
106106

107107
## Next Steps
108108

109-
* [Quickstart Guide](./quickstart.md)
109+
* [Quickstart Guide](quickstart.md)

docs/testing/running/pytest-compatibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
`invariant test` is a lightweight wrapper of the original `pytest` CLI. It is designed to be a drop-in replacement for `pytest` in your existing test suite.
1010

11-
On top of the standard `pytest` arguments, `invariant test` supports the following extra arguments to enable [pushing to Explorer](./Visual_Debugger.md).
11+
On top of the standard `pytest` arguments, `invariant test` supports the following extra arguments to enable [pushing to Explorer](./visual-debugging.md).
1212

1313
**Extra Arguments**
1414

docs/testing/writing/integrate.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -36,44 +36,28 @@ Each message has a `role` key that specifies the role of the speaker (e.g., `use
3636

3737
Based on this simple format, it is easy to integrate your agent with Invariant `testing`.
3838

39-
> **Extended Format Support** `testing` also supports additional custom properties in the trace format, e.g. for metadata. Note, however, that convenience methods like `Trace.tool_calls()` assume the standard format. Similarly, if you are planning to visualize the trace in [Explorer](/explorer/), we advise you to stick to the standard format.
39+
> **Extended Format Support** `testing` also supports additional custom properties in the trace format, e.g. for metadata. Note, however, that convenience methods like `Trace.tool_calls()` assume the standard format. Similarly, if you are planning to visualize the trace in [Explorer](explorer/index.md), we advise you to stick to the standard format.
4040
4141
To learn about how to do this, follow one of the example guides below:
4242

4343
<div class='tiles'>
4444

45-
<<<<<<< HEAD
46-
<a href="/docs/testing/Examples/computer-use/" class='tile primary'>
47-
=======
4845
<a href="/testing/examples/computer-use/" class='tile primary'>
49-
>>>>>>> 068f461 (Add redirects so that we continue to support the older URLs till we move them to the new URLs.)
5046
<span class='tile-title'>Computer Use Agents →</span>
5147
<span class='tile-description'>Integrate your computer use agent with Invariant <code>testing</code></span>
5248
</a>
5349

54-
<<<<<<< HEAD
55-
<a href="/docs/testing/Examples/langgraph/" class='tile primary'>
56-
=======
5750
<a href="/testing/examples/langgraph/" class='tile primary'>
58-
>>>>>>> 068f461 (Add redirects so that we continue to support the older URLs till we move them to the new URLs.)
5951
<span class='tile-title'>LangGraph Agents →</span>
6052
<span class='tile-description'>Test your LangGraph agent with <code>testing</code></span>
6153
</a>
6254

63-
<<<<<<< HEAD
64-
<a href="/docs/testing/Examples/openai-python-agent/" class='tile'>
65-
=======
6655
<a href="/testing/examples/openai-python-agent/" class='tile'>
67-
>>>>>>> 068f461 (Add redirects so that we continue to support the older URLs till we move them to the new URLs.)
6856
<span class='tile-title'>Function Calling Agents →</span>
6957
<span class='tile-description'>Integrate your agent with Invariant <code>testing</code> using function calls</span>
7058
</a>
7159

72-
<<<<<<< HEAD
73-
<a href="/docs/testing/Examples/swarm/" class='tile'>
74-
=======
7560
<a href="/testing/examples/swarm/" class='tile'>
76-
>>>>>>> 068f461 (Add redirects so that we continue to support the older URLs till we move them to the new URLs.)
7761
<span class='tile-title'>Swarm Agents →</span>
7862
<span class='tile-description'>Test your swarm agent with Invariant <code>testing</code></span>
7963
</a>

0 commit comments

Comments
 (0)