You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: fix README rendering on PyPI (absolute URLs, dynamic version badge) (#66)
PyPI does not resolve repo-relative paths in the long description, so the
logo and several file links were broken on the package page, and the static
version badge had drifted to 0.2.0 while 0.2.3 is published.
- Logo <picture>/<img> -> absolute raw.githubusercontent.com URLs
- All repo file/dir links -> absolute github.com/blob|tree/main URLs
- Version badge -> dynamic shields.io pypi/v (never goes stale)
- CHANGELOG: note under [Unreleased]
In-page anchor links left relative (they work on PyPI).
Signed-off-by: Tom Li <tom@shyftlabs.io>
Copy file name to clipboardExpand all lines: CHANGELOG.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ and Continuum adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.ht
21
21
- Open LLM provider registry — `register_provider(prefix, factory)` and `register_default_provider(factory)` let new backends extend model-name routing without editing core (`get_provider` now resolves via longest-prefix match against the registry).
22
22
23
23
### Changed
24
-
-_Nothing yet._
24
+
-README now renders correctly on the PyPI project page: the logo and all repository links use absolute URLs (PyPI does not resolve repo-relative paths), and the version badge is a dynamic `pypi/v` shield instead of a hardcoded number that drifted out of date.
25
25
26
26
### Fixed
27
27
- Docker healthchecks for `qdrant` (now probes `/readyz` over bash `/dev/tcp`, since the image ships no `curl`) and `temporal` (`BIND_ON_IP=0.0.0.0` so the localhost healthcheck can reach the frontend) — both previously reported `unhealthy` while serving correctly.
[](https://github.com/shyftlabs/continuum/blob/main/CODE_OF_CONDUCT.md)
Continuum is configured through environment variables (copy [`.env.template`](.env.template) → `.env`). Set keys only for the providers and components you use — everything else has sensible defaults. The most common settings:
109
+
Continuum is configured through environment variables (copy [`.env.template`](https://github.com/shyftlabs/continuum/blob/main/.env.template) → `.env`). Set keys only for the providers and components you use — everything else has sensible defaults. The most common settings:
110
110
111
111
#### LLM providers & routing
112
112
@@ -150,7 +150,7 @@ Continuum is configured through environment variables (copy [`.env.template`](.e
> Optional extras: `pip install -e ".[temporal]"` for Temporal, `".[eval]"` for evaluation, `".[embeddings]"` for local embeddings. See [`.env.template`](.env.template) for the complete, annotated reference.
153
+
> Optional extras: `pip install -e ".[temporal]"` for Temporal, `".[eval]"` for evaluation, `".[embeddings]"` for local embeddings. See [`.env.template`](https://github.com/shyftlabs/continuum/blob/main/.env.template) for the complete, annotated reference.
154
154
155
155
## 🧩 Components
156
156
@@ -169,27 +169,27 @@ Continuum is configured through environment variables (copy [`.env.template`](.e
169
169
170
170
Full documentation lives at **[docs.continuum.shyftlabs.io](https://docs.continuum.shyftlabs.io/)** — guides for building & running agents, Smart Inference, memory, tools/MCP, workflows, handoffs, streaming, evaluation, and the research behind it.
171
171
172
-
Markdown sources are also in [`docs/`](docs/) if you prefer reading on GitHub — e.g. [`agent.md`](docs/agent.md), [`memory.md`](docs/memory.md), [`tools.md`](docs/tools.md), and the integration [`GUIDE.md`](docs/GUIDE.md).
172
+
Markdown sources are also in [`docs/`](https://github.com/shyftlabs/continuum/tree/main/docs) if you prefer reading on GitHub — e.g. [`agent.md`](https://github.com/shyftlabs/continuum/blob/main/docs/agent.md), [`memory.md`](https://github.com/shyftlabs/continuum/blob/main/docs/memory.md), [`tools.md`](https://github.com/shyftlabs/continuum/blob/main/docs/tools.md), and the integration [`GUIDE.md`](https://github.com/shyftlabs/continuum/blob/main/docs/GUIDE.md).
173
173
174
174
## 🧪 Examples
175
175
176
-
Runnable demos live under [`playground/`](playground/):
176
+
Runnable demos live under [`playground/`](https://github.com/shyftlabs/continuum/tree/main/playground):
177
177
178
178
-**`gateway-local-shop`** — an MCP server + agent + chat UI for a pet-shop assistant (end-to-end: server → agent → UI).
179
179
-**`gateway-multi-agent-shop`** — a multi-agent workflow variant with routing and handoffs.
180
180
-**`frontend/`** — the demo web UIs (`assortment`, `commerce-chat`).
181
181
182
182
## 🤝 Contributing
183
183
184
-
Contributions are welcome! Please read [`CONTRIBUTING.md`](CONTRIBUTING.md) for the branch model, Conventional Commits, DCO sign-off, and local setup. By participating you agree to our [Code of Conduct](CODE_OF_CONDUCT.md).
184
+
Contributions are welcome! Please read [`CONTRIBUTING.md`](https://github.com/shyftlabs/continuum/blob/main/CONTRIBUTING.md) for the branch model, Conventional Commits, DCO sign-off, and local setup. By participating you agree to our [Code of Conduct](https://github.com/shyftlabs/continuum/blob/main/CODE_OF_CONDUCT.md).
185
185
186
-
- 🐛 **Bugs & features** — use the [issue templates](.github/ISSUE_TEMPLATE)
186
+
- 🐛 **Bugs & features** — use the [issue templates](https://github.com/shyftlabs/continuum/tree/main/.github/ISSUE_TEMPLATE)
- 🔒 **Security** — report privately via [`SECURITY.md`](SECURITY.md), never a public issue
188
+
- 🔒 **Security** — report privately via [`SECURITY.md`](https://github.com/shyftlabs/continuum/blob/main/SECURITY.md), never a public issue
0 commit comments