Skip to content

docs: add AGENTS.md (and CLAUDE.md pointer) - #47

Merged
songxuchen merged 2 commits into
mainfrom
docs/agents-md
Oct 13, 2026
Merged

songxuchen merged 2 commits into
mainfrom
docs/agents-md

Conversation

@songxuchen

Copy link
Copy Markdown
Contributor

Adds an AGENTS.md covering the three packages, layout, the CI commands, conventions for changes and new endpoints, the tag-driven PyPI releases, SDK and CLI entry points with a short example, length caps and the error classes. CLAUDE.md is a one-line @AGENTS.md import.

Also fixes a few facts that disagreed with the API:

  • Key placeholders in the README and examples read sk_...; real keys start with sk-.
  • The Quickstart and examples/generate.py saved the streamed track as output.mp3; generate() returns m4a, as the output_format section of the README says.
  • A context7.json rule said dubbing has no free run; the README and the API give one free 15-second preview.

Covers the three packages, layout, the CI commands, conventions for changes and
new endpoints, the tag-driven releases, SDK and CLI entry points, length caps and
the error classes. CLAUDE.md imports it.
@lightsage-app

lightsage-app Bot commented Oct 13, 2026

Copy link
Copy Markdown

Lightsage docs evals

Waiting for the staging docs URL before running evals.

Lightsage will start the selected PR evals automatically when GitHub reports a successful docs deployment for this PR. This usually happens within 15 minutes.

Commit: 688808c
Status: waiting for staging docs URL

@songxuchen
songxuchen merged commit 88b7717 into main Oct 13, 2026
2 checks passed
@songxuchen
songxuchen deleted the docs/agents-md branch October 13, 2026 07:43
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.

2 participants