Skip to content

Document TrustedRouter setup#594

Closed
jperla wants to merge 1 commit into
Zoo-Code-Org:mainfrom
jperla:add-trustedrouter-setup-docs
Closed

Document TrustedRouter setup#594
jperla wants to merge 1 commit into
Zoo-Code-Org:mainfrom
jperla:add-trustedrouter-setup-docs

Conversation

@jperla

@jperla jperla commented Jun 12, 2026

Copy link
Copy Markdown

Summary

  • add a README setup section for TrustedRouter
  • document the OpenRouter-compatible base URL https://api.trustedrouter.com/v1
  • list useful router aliases trustedrouter/auto, trustedrouter/zdr, and trustedrouter/e2e

Testing

  • git diff --check

Summary by CodeRabbit

  • Documentation
    • Added TrustedRouter configuration guide to README with setup instructions for using OpenRouter-compatible providers, including API base URL and example model aliases.

@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 47cc0f44-fa86-4477-9747-5fc76a5c044e

📥 Commits

Reviewing files that changed from the base of the PR and between ed868c6 and 394b6ef.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

This PR adds a new "TrustedRouter" documentation section to README.md, explaining how to configure Zoo Code to use TrustedRouter as an OpenRouter-compatible provider with API key authentication and the base URL https://api.trustedrouter.com/v1, including example model aliases.

Changes

Documentation Updates

Layer / File(s) Summary
TrustedRouter provider documentation
README.md
Adds a new TrustedRouter section documenting provider path configuration, API key setup, API base URL, and example model aliases (trustedrouter/auto, trustedrouter/zdr, trustedrouter/e2e).

🎯 1 (Trivial) | ⏱️ ~3 minutes

🐰 A new path in the woods appears,
TrustedRouter clears the fears,
Configuration now laid bare,
Eight lines of docs floating through the air! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is missing required sections from the template: Related GitHub Issue, Test Procedure, Pre-Submission Checklist, and Discord contact information. Add the missing required sections from the template, particularly link the PR to a GitHub issue and provide detailed test procedures beyond git diff --check.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding documentation for TrustedRouter setup to the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov

codecov Bot commented Jun 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@edelauna edelauna left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to close this PR, can you please open a PR in https://github.com/Zoo-Code-Org/Zoo-Code-Docs

Comment thread README.md
Comment on lines +70 to +76
## TrustedRouter

TrustedRouter exposes an OpenRouter-compatible API. To use it in Zoo Code,
choose the OpenRouter-compatible/custom provider path, paste your
TrustedRouter API key, and set the API base URL to
`https://api.trustedrouter.com/v1`. Useful model aliases include
`trustedrouter/auto`, `trustedrouter/zdr`, and `trustedrouter/e2e`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This content would be a better fit in Zoo-Code-Docs under docs/providers/ — there are already individual provider pages for OpenRouter, Requesty, etc. that follow a consistent format (frontmatter with keywords/description, Getting an API Key, Configuration, Tips sections).

A new docs/providers/trustedrouter.md following the same template would be the natural home for this.

Also worth noting: the main repo README has 17 localized copies under locales/ (ca, de, es, fr, hi, id, it, ja, ko, nl, pl, pt-BR, ru, tr, vi, zh-CN, zh-TW). Adding a section here without updating those creates i18n drift — another reason to keep provider-specific setup in the docs site instead.

@jperla

jperla commented Jun 28, 2026

Copy link
Copy Markdown
Author

Moved this to Zoo Code Docs as requested: Zoo-Code-Org/Zoo-Code-Docs#5

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