Skip to content

docs: simplify onboarding and demo explanations#131

Merged
rlippmann merged 2 commits into
mainfrom
codex/doc-simplification
May 21, 2026
Merged

docs: simplify onboarding and demo explanations#131
rlippmann merged 2 commits into
mainfrom
codex/doc-simplification

Conversation

@rlippmann
Copy link
Copy Markdown
Owner

@rlippmann rlippmann commented May 21, 2026

What changed

  • Simplified the top-level onboarding language in README.md to be behavior-first and easier for new users to scan.
  • Clarified wording in core docs:
    • docs/README.md
    • docs/DescriptionAndMilestones.md
  • Simplified integration documentation phrasing in:
    • examples/integrations/README.md
    • examples/integrations/openwebui/README.md
    • examples/integrations/litellm/README.md
    • examples/integrations/litellm_proxy/README.md
  • Performed a conservative clarity pass on demo-facing docs in demos/README.md (user-facing explanation text only).
  • Bumped package version to 0.6.20 in pyproject.toml and the corresponding uv.lock entry.

Why

  • Make the project easier to understand for first-time users without changing behavior, contracts, or evidence.
  • Replace abstract phrasing with smaller, concrete wording where safe.
  • Improve demo readability so users can quickly see what behavior changes they should notice.

Checklist

  • pre-commit run (uv run pre-commit run --all-files)
  • tests pass (uv run pytest)

@rlippmann rlippmann merged commit 33b7241 into main May 21, 2026
12 checks passed
@rlippmann rlippmann deleted the codex/doc-simplification branch May 21, 2026 01:23
@rlippmann rlippmann changed the title docs: simplify onboarding language docs: simplify onboarding and demo explanations May 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant