Skip to content

Commit 28168b7

Browse files
committed
Disable docs versions
1 parent 31e305e commit 28168b7

File tree

5 files changed

+38
-16
lines changed

5 files changed

+38
-16
lines changed

docs/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,23 @@ All commands are run from the root of the project, from a terminal:
1919
| `npm run preview` | Preview your build locally, before deploying |
2020
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
2121
| `npm run astro -- --help` | Get help using the Astro CLI |
22+
23+
24+
## How to enable versioning
25+
26+
- Add the following to the `astro.config.mjs` file:
27+
28+
```js
29+
base: '/v0.3',
30+
outDir: './dist/v0.3',
31+
```
32+
33+
34+
- Add the following to the `astro.config.mjs` file:
35+
36+
```js
37+
components: {
38+
// Override the default `SocialIcons` component.
39+
ThemeSelect: './src/components/ThemeSelect.astro',
40+
},
41+
```

docs/astro.config.mjs

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ import rehypeMathjax from 'rehype-mathjax';
66
// https://astro.build/config
77
export default defineConfig({
88
site: 'https://docs.relari.ai',
9-
base: '/v0.3',
10-
outDir: './dist/v0.3',
9+
// base: '/v0.3',
10+
// outDir: './dist/v0.3',
11+
base: '.',
12+
outDir: './dist',
1113
trailingSlash: "never",
1214
markdown: {
1315
remarkPlugins: [remarkMath],
@@ -16,10 +18,10 @@ export default defineConfig({
1618
integrations: [
1719
starlight({
1820
title: 'Continuous Eval',
19-
components: {
20-
// Override the default `SocialIcons` component.
21-
ThemeSelect: './src/components/ThemeSelect.astro',
22-
},
21+
// components: {
22+
// // Override the default `SocialIcons` component.
23+
// ThemeSelect: './src/components/ThemeSelect.astro',
24+
// },
2325
tableOfContents: { minHeadingLevel: 2, maxHeadingLevel: 4, },
2426
customCss: [
2527
// Relative path to your custom CSS file

docs/src/content/docs/getting-started/Introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ sidebar:
1111

1212
`continuous-eval` is an open-source package created for granular and holistic evaluation of GenAI application pipelines.
1313

14-
<img src="/v0.3/module-level-eval.png"></img>
14+
<img src="/module-level-eval.png"></img>
1515

1616
## How is continuous-eval different?
1717

docs/src/content/docs/getting-started/quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ title: Quick Start
33
description: Quick Start
44
---
55

6-
If you haven't installed continuous-eval, go [here](../../v0.3/getting-started/installation/).
6+
If you haven't installed continuous-eval, go [here](../../getting-started/installation/).
77

88
## Run a single metric
99

10-
Import the metric of your choice ([see all metrics](../../v0.3/metrics/overview/)) and get the results.
10+
Import the metric of your choice ([see all metrics](../../metrics/overview/)) and get the results.
1111

1212
```python
1313
from continuous_eval.metrics.retrieval import PrecisionRecallF1
@@ -96,7 +96,7 @@ if __name__ == "__main__":
9696

9797
Continuous-eval is designed to support multi-module evaluation. In this case we instead suppose the system is composed by one single module (the retriever) so we can use the `SingleModulePipeline` class to setup the pipeline.
9898

99-
In the pipeline we added both metrics (i.e., `PrecisionRecallF1` and `RankedRetrievalMetrics`) and tests (i.e., `GreaterOrEqualThan` on the recall metric). Read more about this in the [Metrics and Tests](../../v0.3/pipeline/metrics_and_tests) page.
99+
In the pipeline we added both metrics (i.e., `PrecisionRecallF1` and `RankedRetrievalMetrics`) and tests (i.e., `GreaterOrEqualThan` on the recall metric). Read more about this in the [Metrics and Tests](../../pipeline/metrics_and_tests) page.
100100

101101
## Curate a golden dataset
102102

docs/src/content/docs/index.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import { Icon } from '@astrojs/starlight/components';
1414
<LinkCard
1515
title="🚀 Getting Started"
1616
description="Install the package and learn how to get started quickly."
17-
href="v0.3/getting-started/introduction/"
17+
href="getting-started/introduction/"
1818
/>
1919
</CardGrid>
2020

@@ -24,22 +24,22 @@ import { Icon } from '@astrojs/starlight/components';
2424
<LinkCard
2525
title="🚰 Pipeline"
2626
description="Define your GenAI application pipeline and run evaluation over a tailored dataset."
27-
href="v0.3/pipeline/pipeline/"
27+
href="pipeline/pipeline/"
2828
/>
2929
<LinkCard
3030
title="📊 Metrics"
3131
description="Explore the available metrics and learn how to combine multiple metrics effectively."
32-
href="v0.3/metrics/overview/"
32+
href="metrics/overview/"
3333
/>
3434
<LinkCard
3535
title="🔍 Datasets"
36-
description="Explore sample datasets and try generating a synthetic evaluation dataset from documents."
37-
href="v0.3/dataset/example_datasets/"
36+
description="Explore sample datasets try to run evaluation on them."
37+
href="pipeline/eval_dataset/"
3838
/>
3939
<LinkCard
4040
title="💡 Examples"
4141
description="Discover code snippets and examples to help you understand and implement different evaluation pipelines."
42-
href="v0.3/examples/basics/0_single_metric/"
42+
href="examples/basics/0_single_metric/"
4343
/>
4444
</CardGrid>
4545

0 commit comments

Comments
 (0)