Skip to content

Commit b94cefa

Browse files
authored
docs: fix broken doc link (#670)
1 parent 6fbf57b commit b94cefa

File tree

9 files changed

+37
-19
lines changed

9 files changed

+37
-19
lines changed

.env.example

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,5 @@ TIDB_PASSWORD=
1717
TIDB_DATABASE=
1818
TIDB_SSL=true
1919

20-
# EMBEDDING_MAX_TOKENS indicates the max size of document chunks.
21-
#
22-
# EMBEDDING_MAX_TOKENS should be smaller than the embedding model's max tokens due
23-
# to the tokenizer difference. (see: https://github.com/pingcap/autoflow/issues/397)
24-
#
25-
# Go to https://tidb.ai/docs/embedding-model to check the max tokens of the embedding model.
26-
#
27-
# Notice: this variable will be deprecated in the future.
28-
EMBEDDING_MAX_TOKENS=2048
29-
3020
# JS Widgets: if you want to use JS widgets, you need to set the following variables to enable CORS.
3121
# BACKEND_CORS_ORIGINS=https://your-domain.com

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In this section, you should have some prerequisites software installed on your l
1717

1818
#### Setting up your development environment
1919

20-
Setting up the project on your local machine is the first step to contributing to the project. You can clone the project from the GitHub repository and then start the project on your local machine. You can follow the instructions in the [Deployment Guide](https://tidb.ai/docs/deploy-with-docker) file to set up the project on your local machine.
20+
Setting up the project on your local machine is the first step to contributing to the project. You can clone the project from the GitHub repository and then start the project on your local machine. You can follow the instructions in the [Deployment Guide](https://autoflow.tidb.ai/deploy-with-docker) file to set up the project on your local machine.
2121

2222
To test your local changes, you can build and run the project using:
2323

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
AutoFlow is an open source graph rag (graphrag: knowledge graph rag) based knowledge base tool built on top of [TiDB Vector](https://www.pingcap.com/ai?utm_source=tidb.ai&utm_medium=community) and [LlamaIndex](https://github.com/run-llama/llama_index) and [DSPy](https://github.com/stanfordnlp/dspy).
2222

2323
- **Live Demo**: [https://tidb.ai](https://tidb.ai?utm_source=tidb.ai&utm_medium=community)
24-
- **Deployment Docs**: [Deployment Docs](https://tidb.ai/docs/?utm_source=github&utm_medium=tidb.ai)
24+
- **Deployment Docs**: [Deployment Docs](https://autoflow.tidb.ai/?utm_source=github&utm_medium=tidb.ai)
2525

2626
## Features
2727

@@ -35,7 +35,7 @@ AutoFlow is an open source graph rag (graphrag: knowledge graph rag) based knowl
3535

3636
## Deploy
3737

38-
- [Deploy with Docker Compose](https://tidb.ai/docs/deploy-with-docker) (with: 4 CPU cores and 8GB RAM)
38+
- [Deploy with Docker Compose](https://autoflow.tidb.ai/deploy-with-docker) (with: 4 CPU cores and 8GB RAM)
3939

4040
## Tech Stack
4141

backend/app/site_settings/default_settings.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ website:
2525
homepage_footer_links:
2626
default:
2727
- text: "Release Notes"
28-
href: "https://tidb.ai/docs/changelog"
28+
href: "https://autoflow.tidb.ai/releases"
2929
- text: "Powered by TiDB"
3030
href: "https://tidb.cloud/ai"
3131
- text: "© 2024 PingCAP"

docs/next.config.mjs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@ import nextra from 'nextra'
22

33
const withNextra = nextra({
44
latex: true,
5+
defaultShowCopyCode: true,
56
search: {
6-
codeblocks: false
7+
codeblocks: true
78
},
89
contentDirBasePath: '/',
910
})

docs/src/app/layout.jsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export default async function RootLayout({ children }) {
3535
</span>
3636
</div>
3737
}
38-
logoLink="/docs"
38+
logoLink="/"
3939
projectLink="https://github.com/pingcap/autoflow"
4040
>
4141
<div style={{ display: 'flex', alignItems: 'center', gap: '1rem' }}>

docs/src/content/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
AutoFlow is an open source graph rag (graphrag: knowledge graph rag) based knowledge base tool built on top of [TiDB Vector](https://www.pingcap.com/ai?utm_source=tidb.ai&utm_medium=community) and [LlamaIndex](https://github.com/run-llama/llama_index) and [DSPy](https://github.com/stanfordnlp/dspy).
2222

2323
- **Live Demo**: [https://tidb.ai](https://tidb.ai?utm_source=tidb.ai&utm_medium=community)
24-
- **Deployment Docs**: [Deployment Docs](https://tidb.ai/docs/?utm_source=github&utm_medium=tidb.ai)
24+
- **Deployment Docs**: [Deployment Docs](https://autoflow.tidb.ai/?utm_source=github&utm_medium=tidb.ai)
2525

2626
## Features
2727

@@ -35,7 +35,7 @@ AutoFlow is an open source graph rag (graphrag: knowledge graph rag) based knowl
3535

3636
## Deploy
3737

38-
- [Deploy with Docker Compose](https://tidb.ai/docs/deploy-with-docker) (with: 4 CPU cores and 8GB RAM)
38+
- [Deploy with Docker Compose](https://autoflow.tidb.ai/deploy-with-docker) (with: 4 CPU cores and 8GB RAM)
3939

4040
## Tech Stack
4141

docs/src/content/releases/index.mdx

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Releases
3+
asIndexPage: true
4+
---
5+
6+
# Releases
7+
8+
import { Cards } from 'nextra/components'
9+
10+
<Cards>
11+
<Cards.Card
12+
title="v0.4.0"
13+
href="/releases/v0.4.0"
14+
/>
15+
<Cards.Card
16+
title="v0.3.0"
17+
href="/releases/v0.3.0"
18+
/>
19+
<Cards.Card
20+
title="v0.2.0"
21+
href="/releases/v0.2.0"
22+
/>
23+
<Cards.Card
24+
title="v0.1.0"
25+
href="/releases/v0.1.0"
26+
/>
27+
</Cards>

docs/src/content/releases/v0.2.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@
1414
- Fixed a SiteSetting cache issue that prevented proper synchronization across processes.
1515

1616

17-
If you are deploying tidb.ai using docker, please refer to this [document](https://tidb.ai/docs/deploy-with-docker#upgrade) for upgrading your tidb.ai.
17+
If you are deploying tidb.ai using docker, please refer to this [document](https://autoflow.tidb.ai/deploy-with-docker#upgrade) for upgrading your tidb.ai.

0 commit comments

Comments
 (0)