Skip to content

Commit 5dc0db8

Browse files
committed
Tighten Sourcey integration docs voice
1 parent 49068ac commit 5dc0db8

6 files changed

Lines changed: 24 additions & 20 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
[![PyPI - License](https://img.shields.io/pypi/l/langchain-sourcey)](https://pypi.org/project/langchain-sourcey/)
55
[![CI](https://github.com/sourcey/langchain-sourcey/actions/workflows/ci.yml/badge.svg)](https://github.com/sourcey/langchain-sourcey/actions/workflows/ci.yml)
66

7-
Build your own Ask AI on top of a published Sourcey docs site.
7+
Implement Ask AI over a published Sourcey docs site.
88

9-
`langchain-sourcey` is the retrieval layer behind that feature.
9+
`langchain-sourcey` reads Sourcey's generated search and LLM artefacts and
10+
returns canonical page URLs for citation.
1011

1112
Sourcey already emits the files a retriever needs:
1213

@@ -49,7 +50,7 @@ for doc in docs:
4950

5051
For a runnable script, see [examples/live_quickstart.py](examples/live_quickstart.py).
5152

52-
More context: `https://sourcey.com/docs/guides/guide-langchain-retriever`
53+
More context: [Sourcey guide](https://sourcey.com/docs/guides/guide-langchain-retriever)
5354

5455
## Implement Ask AI
5556

@@ -90,9 +91,9 @@ print(answer)
9091

9192
For a fuller example, see [examples/rag_chain.py](examples/rag_chain.py).
9293

93-
## What Has To Exist
94+
## Sourcey Output Contract
9495

95-
For clean retrieval, the published Sourcey site should expose:
96+
For predictable retrieval, the published Sourcey site should expose:
9697

9798
- publish `search-index.json`
9899
- publish `llms-full.txt`

‎docs/langchain-js/provider-sourcey.mdx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ description: "Build Ask AI over Sourcey docs using LangChain JavaScript."
55

66
[Sourcey](https://sourcey.com) builds static docs sites.
77

8-
`langchain-sourcey` is the retrieval layer behind an Ask AI feature over a
9-
published Sourcey docs site.
8+
Use `langchain-sourcey` to retrieve from a published Sourcey docs site. It
9+
reads `search-index.json`, uses `llms-full.txt` when present, and returns
10+
canonical page URLs for citation.
1011

1112
## Installation and setup
1213

‎docs/langchain-js/retriever-sourcey.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ description: "Integrate with the SourceyRetriever retriever using LangChain Java
55

66
[Sourcey](https://sourcey.com) already emits the files this retriever needs.
77

8-
`SourceyRetriever` is the retrieval layer behind an Ask AI flow over a Sourcey
9-
docs site. It reads `search-index.json`, hydrates from `llms-full.txt`, and
10-
returns `Document` objects with canonical page URLs in `metadata.source`.
8+
Use `SourceyRetriever` to retrieve from a published Sourcey docs site. It
9+
reads `search-index.json`, uses `llms-full.txt` when present, and returns
10+
`Document` objects with canonical page URLs in `metadata.source`.
1111

1212
## Integration details
1313

‎docs/langchain/provider-sourcey.mdx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ description: "Build Ask AI over Sourcey docs using LangChain Python."
55

66
[Sourcey](https://sourcey.com) builds static docs sites.
77

8-
`langchain-sourcey` is the retrieval layer behind an Ask AI feature over a
9-
published Sourcey docs site.
8+
Use `langchain-sourcey` to retrieve from a published Sourcey docs site. It
9+
reads `search-index.json`, uses `llms-full.txt` when present, and returns
10+
canonical page URLs for citation.
1011

1112
## Installation and setup
1213

‎docs/langchain/retriever-sourcey.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ description: "Integrate with the Sourcey retriever using LangChain Python."
55

66
[Sourcey](https://sourcey.com) already emits the files this retriever needs.
77

8-
`SourceyRetriever` is the retrieval layer behind an Ask AI flow over a Sourcey
9-
docs site. It reads `search-index.json`, hydrates from `llms-full.txt`, and
10-
returns `Document` objects with canonical page URLs in `metadata["source"]`.
8+
Use `SourceyRetriever` to retrieve from a published Sourcey docs site. It
9+
reads `search-index.json`, uses `llms-full.txt` when present, and returns
10+
`Document` objects with canonical page URLs in `metadata["source"]`.
1111

1212
## Setup
1313

‎js/README.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# langchain-sourcey
22

3-
Build your own Ask AI on top of a published Sourcey docs site.
3+
Implement Ask AI over a published Sourcey docs site.
44

5-
`langchain-sourcey` is the retrieval layer behind that feature.
5+
`langchain-sourcey` reads Sourcey's generated search and LLM artefacts and
6+
returns canonical page URLs for citation.
67

78
Sourcey already emits the files a retriever needs:
89

@@ -54,7 +55,7 @@ for (const doc of docs) {
5455

5556
For a runnable script, see [examples/live-quickstart.ts](examples/live-quickstart.ts).
5657

57-
More context: `https://sourcey.com/docs/guides/guide-langchain-retriever`
58+
More context: [Sourcey guide](https://sourcey.com/docs/guides/guide-langchain-retriever)
5859

5960
## Implement Ask AI
6061

@@ -119,9 +120,9 @@ console.log(answer);
119120

120121
For a fuller example, see [examples/rag-chain.ts](examples/rag-chain.ts).
121122

122-
## What Has To Exist
123+
## Sourcey Output Contract
123124

124-
For clean retrieval, the published Sourcey site should expose:
125+
For predictable retrieval, the published Sourcey site should expose:
125126

126127
- publish `search-index.json`
127128
- publish `llms-full.txt`

0 commit comments

Comments
 (0)