Update docs

[scosman]

Needed fix for CI builds

Summary by CodeRabbit

• Documentation

  • Improved and expanded documentation for connecting AI providers and programmatically tagging task runs in the core library README.
  • Updated example code for creating TaskRuns with clearer argument usage.
  • Enhanced descriptions in the "Create Issue Eval" dialog to clarify how to provide examples.

• Chores

  • Updated build configuration for the desktop app to clarify wheel creation settings and prevent related build errors.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update modifies three areas: it updates the desktop app's build configuration in pyproject.toml to clarify wheel creation intent, revises user guidance text in a Svelte UI component for creating evaluation templates, and expands the core library's README with new sections and improved code examples. No functional or API changes are introduced.

Changes

File(s)	Change Summary
app/desktop/pyproject.toml	Added [build-system] section for hatchling; minimal wheel config to only include __init__.py.
app/web_ui/src/routes/(app)/evals/[project_id]/[task_id]/create_evaluator/select_eval_template.svelte	Updated help text for form elements to clarify example formatting flexibility.
libs/core/README.md	Expanded documentation: added sections on connecting AI providers and tagging task runs; updated code examples.

Estimated code review effort

1 (~4 minutes)

Possibly related PRs

• Fix CI Issue #449: Also modifies app/desktop/pyproject.toml to add a [build-system] section and minimal wheel configuration, indicating a shared focus on build setup.

Poem

In the garden of code where the docs gently grow,
A README now blossoms, with examples in tow.
Build wheels roll smoothly, just as they should,
And UI hints sparkle, now better understood.
🐇✨ Hopping forward, the project feels bright—
With every small change, we code toward the light!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 98432c5 and 2fc907e.

⛔ Files ignored due to path filters (1)

• uv.lock is excluded by !**/*.lock

📒 Files selected for processing (3)

• app/desktop/pyproject.toml (2 hunks)
• app/web_ui/src/routes/(app)/evals/[project_id]/[task_id]/create_evaluator/select_eval_template.svelte (2 hunks)
• libs/core/README.md (5 hunks)

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.