Skip to content

Commit 9396333

Browse files
committed
Tighten docs voice and update docs URL
1 parent 75701c4 commit 9396333

6 files changed

Lines changed: 31 additions & 33 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog
22

3+
## 0.1.3 - 2026-04-24
4+
5+
- pointed package documentation at a dedicated Sourcey docs guide
6+
- tightened package copy and removed the download badge
7+
38
## 0.1.2 - 2026-04-24
49

510
- improved the package README and added runnable example scripts

‎README.md‎

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,32 @@
11
# langchain-sourcey
22

33
[![PyPI - Version](https://img.shields.io/pypi/v/langchain-sourcey?label=%20)](https://pypi.org/project/langchain-sourcey/)
4-
[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-sourcey)](https://pypistats.org/packages/langchain-sourcey)
54
[![PyPI - License](https://img.shields.io/pypi/l/langchain-sourcey)](https://pypi.org/project/langchain-sourcey/)
65
[![CI](https://github.com/sourcey/langchain-sourcey/actions/workflows/ci.yml/badge.svg)](https://github.com/sourcey/langchain-sourcey/actions/workflows/ci.yml)
76

8-
`langchain-sourcey` is the native LangChain retriever for Sourcey-generated
9-
documentation sites.
7+
> Your docs retriever should not depend on somebody else's SaaS either.
108
11-
It turns a published Sourcey docs root into a LangChain knowledge source
12-
without a private indexing service or ingestion pipeline. The retriever works
13-
directly against Sourcey's public artefacts:
9+
`langchain-sourcey` reads a published Sourcey docs site directly.
10+
11+
Sourcey already ships the files a retriever needs. This package uses them:
1412

1513
- `search-index.json` for candidate discovery
1614
- `llms-full.txt` for full-page hydration
1715
- canonical page URLs for citations
1816

19-
## Why this integration is a good LangChain fit
20-
21-
- No credentials required for public docs sites
22-
- Retrieval works against static hosting, subpath deployments, and GitHub Pages
23-
- Returned `Document` objects carry canonical `metadata["source"]` URLs
24-
- `llms-full.txt` gives cleaner full-page content than scraping rendered HTML
25-
- If `llms-full.txt` is missing, the retriever falls back to page HTML
17+
If `llms-full.txt` is missing, it falls back to the matched page HTML.
2618

2719
## Install
2820

2921
```bash
3022
pip install -U langchain-sourcey
3123
```
3224

33-
Point `site_url` at the root of a published Sourcey build, for example
34-
`https://sourcey.com/docs` or `https://sourcey.com/cheesestore`.
25+
Point `site_url` at the root of a published Sourcey build:
26+
27+
- `https://sourcey.com/docs`
28+
- `https://sourcey.com/cheesestore`
29+
- `https://cheesestore.github.io`
3530

3631
## Quickstart
3732

@@ -54,6 +49,8 @@ for doc in docs:
5449

5550
For a runnable script, see [examples/live_quickstart.py](examples/live_quickstart.py).
5651

52+
Sourcey guide: `https://sourcey.com/docs/guides/guide-langchain-retriever.html`
53+
5754
## Use In A LangChain Chain
5855

5956
Install a chat model integration of your choice. This example uses OpenAI:
@@ -93,17 +90,16 @@ print(answer)
9390

9491
For a fuller example, see [examples/rag_chain.py](examples/rag_chain.py).
9592

96-
## Sourcey Site Contract
93+
## Sourcey Contract
9794

98-
For best results, the published Sourcey site should:
95+
This package assumes the published Sourcey site exposes:
9996

10097
- publish `search-index.json`
10198
- publish `llms-full.txt`
10299
- set `siteUrl` in `sourcey.config.ts` so citations are canonical
103100

104101
`search-index.json` is required. `llms-full.txt` is strongly recommended because
105-
it lets the retriever return full page content instead of HTML-derived fallback
106-
text.
102+
it gives the retriever full page content instead of HTML-derived fallback text.
107103

108104
## Returned Metadata
109105

@@ -141,6 +137,4 @@ This repo includes draft docs ready to turn into a LangChain docs PR:
141137

142138
## Scope
143139

144-
This package intentionally ships `SourceyRetriever` only. A document loader is
145-
deferred until the retriever proves enough demand to justify the maintenance
146-
surface.
140+
This package ships `SourceyRetriever` only. No loader yet.

‎docs/langchain/provider-sourcey.mdx‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,20 @@ description: "Integrate with Sourcey using LangChain Python."
44
---
55

66
> [Sourcey](https://sourcey.com) turns documentation, API references, and MCP
7-
> servers into static sites built for both humans and LLMs.
8-
> `langchain-sourcey` lets LangChain retrieve directly from those published
9-
> Sourcey artefacts.
7+
> servers into static sites.
8+
> `langchain-sourcey` reads those published artefacts directly.
109
1110
## Installation and setup
1211

13-
`Sourcey` integration exists in its own partner package. Install it with:
12+
Install `langchain-sourcey`:
1413

1514
```bash
1615
pip install -qU langchain-sourcey
1716
```
1817

1918
No API key is required. Point the retriever at a public Sourcey docs root that
20-
publishes `search-index.json`. `llms-full.txt` is recommended for full-page
21-
hydration and stable citations.
19+
publishes `search-index.json`. If `llms-full.txt` is there, the retriever uses
20+
it for full page content.
2221

2322
## Retriever
2423

‎docs/langchain/retriever-sourcey.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ description: "Integrate with the Sourcey retriever using LangChain Python."
44
---
55

66
> [Sourcey](https://sourcey.com) publishes static documentation sites that
7-
> already contain the retrieval artefacts LangChain needs.
7+
> already contain the retrieval artefacts this package needs.
88
> `SourceyRetriever` searches `search-index.json`, hydrates content from
99
> `llms-full.txt`, and returns `Document` objects with canonical page URLs in
1010
> `metadata["source"]`.
1111
1212
## Setup
1313

14-
Install the partner package:
14+
Install the package:
1515

1616
```bash
1717
pip install -qU langchain-sourcey

‎pyproject.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "langchain-sourcey"
7-
version = "0.1.2"
7+
version = "0.1.3"
88
description = "Native LangChain retriever for Sourcey-generated documentation sites."
99
readme = "README.md"
1010
license = { file = "LICENSE" }
@@ -35,7 +35,7 @@ dev = [
3535

3636
[project.urls]
3737
Homepage = "https://sourcey.com"
38-
Documentation = "https://github.com/sourcey/langchain-sourcey#readme"
38+
Documentation = "https://sourcey.com/docs/guides/guide-langchain-retriever.html"
3939
Repository = "https://github.com/sourcey/langchain-sourcey"
4040
Issues = "https://github.com/sourcey/langchain-sourcey/issues"
4141
Changelog = "https://github.com/sourcey/langchain-sourcey/blob/main/CHANGELOG.md"

‎src/langchain_sourcey/retrievers.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ class SourceyRetriever(BaseRetriever):
9292
top_k: int = Field(default=6, gt=0)
9393
timeout: float = Field(default=10.0, gt=0)
9494
use_llms_full: bool = True
95-
user_agent: str = "langchain-sourcey/0.1.2"
95+
user_agent: str = "langchain-sourcey/0.1.3"
9696
headers: dict[str, str] = Field(default_factory=dict)
9797
transport: httpx.BaseTransport | None = Field(default=None, exclude=True, repr=False)
9898

0 commit comments

Comments
 (0)