docs: bring docs/ in sync with v0.1 surface#35
Merged
mahimairaja merged 3 commits intomainfrom May 4, 2026
Merged
Conversation
Three updates so the VitePress site reflects what shipped: - docs/api/pool.md: AgentPool constructor section now lists every v0.1 kwarg (`isolation`, `max_concurrent_sessions`, `consecutive_failure_limit`) in a typed table, documents the matching read-only properties, and adds a migration note linking to the v0.1.0 changelog. The `server` and `run()` sections call out the coroutine vs process distinction. New "See also" footer links to architecture, density benchmark, and changelog. - docs/getting-started.md: bump stale `livekit-agents~=1.4` reference to `~=1.5` to match the actual pin. - docs/index.md: add a coroutine-mode-worker hero feature; surface the density benchmark + changelog in the "Read the docs" list. The audit doc (historical snapshot) is intentionally untouched.
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Cleans up the repo root by relocating the docs-only Node package files inside the docs/ directory: - `package.json` + `package-lock.json` -> `docs/`. Repo root now has zero JS files; the only package files are the Python ones (pyproject.toml + uv.lock). - npm scripts updated: `vitepress dev docs` -> `vitepress dev .` (now relative to docs/). - .github/workflows/docs.yml + deploy-docs.yml run their npm steps under `defaults.run.working-directory: docs`. Path filters dropped the now-stale `package.json` / `package-lock.json` entries; `cache-dependency-path` / `hashFiles` updated to `docs/package-lock.json`. Also extends .gitignore for two transient artifacts that the new layout / build workflow can produce locally: - `docs/.vitepress/dist/`, `docs/.vitepress/cache/` (VitePress build output / cache). - `.smoke/` (throwaway uv venv used by the wheel-smoke-install step in build.yml). Verified locally: `cd docs && npm install && npm run docs:build` completes; `make ci` is green (374 tests pass, 100% coverage). Run docs locally with `cd docs && npm run docs:dev` (was `npm run docs:dev` from the repo root).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three updates so the VitePress site reflects what shipped:
isolation,max_concurrent_sessions,consecutive_failure_limit) in a typed table, documents the matching read-only properties, and adds a migration note linking to the v0.1.0 changelog. Theserverandrun()sections call out the coroutine vs process distinction. New "See also" footer links to architecture, density benchmark, and changelog.livekit-agents~=1.4reference to~=1.5to match the actual pin.The audit doc (historical snapshot) is intentionally untouched.
Summary
Type of change
Verification
make cipasses locally (lint, format-check, typecheck, tests + 99% coverage gate).docs/andREADME.md(if applicable).## [Unreleased]indocs/changelog.md(for user-visible changes).Notes for the reviewer