Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix docs #622

Merged
merged 1 commit into from
Mar 12, 2024
Merged

Fix docs #622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 1 addition & 19 deletions docs/contributing/documentation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,7 @@ title: Documentation
description: Simple guide to help improve our documentation
---

There are two ways to contribute to our documentation. You can either do it directly from this website or you can clone the repository and run the website locally.

We recommend that you use the first method if you want to make small changes to the documentation. However, if you want to make a bigger change, you can clone the repository and run the website locally.

## Directly from this documentation website

You can create a pull request or an issue for any page, directly from this website. This is the easiest way to contribute to our documentation.

There are two icons on the top right corner of each page. The left one is for opening a pull request and the right one is for opening an issue.

<Frame caption="Cosine distance of embeddings from initial embeddings as they are being learnt with time.">
<img width="800" src="https://uptrain-demo.s3.us-west-1.amazonaws.com/contributing/edit-tools.png"/>
</Frame>

This is convenient for small changes where you don't need to clone the repository and run the website locally.

## Locally

However, if you want to make a bigger change, you can clone the repository and run the website locally by following the instructions below.
Follow the steps below to make changes to the documentation:

1. Fork the repository to your own GitHub account. This will create a copy of the repository that you can make changes to.

Expand Down
2 changes: 1 addition & 1 deletion docs/predefined-evaluations/query-quality/sub-query-completeness.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ We evaluate Sub-Query Completeness by determining which of the following three c
<CardGroup cols={2}>
<Card
title="Tutorial"
href="https://github.com/uptrain-ai/uptrain/blob/main/examples/sub-query/sub-query-completeness.ipynb"
href="https://github.com/uptrain-ai/uptrain/blob/main/examples/checks/sub_query/sub_query_completeness.ipynb"
icon="github"
color="#808080"
>
Expand Down