Repository navigation
docs: comprehensive v0.8.5 documentation update - #63
Conversation
- README: expand features table from 16 to 40+ entries across 5 categories (Core Routing, Multi-Modal APIs, Resilience, Observability, Deployment) - README: update tech stack to reflect 100% TypeScript codebase - README: update Docker tag 0.6.0 → 0.8.5, release command to v0.8.5 - CHANGELOG: add detailed v0.8.5 section (40 commits categorized) covering TLS spoofing, SQLite logs, unified logging, full TS migration, Qwen fix, VPS compatibility, CI improvements, dependency bumps - ARCHITECTURE: update all open-sse file references .js → .ts - CODEBASE_DOCUMENTATION: update all open-sse file references .js → .ts
|
@codex review |
|
To use Codex here, create a Codex account and connect to github. |
Summary of ChangesHello @diegosouzapw, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request delivers a comprehensive update to the project's documentation, aligning it with the significant internal migration to TypeScript across core modules. It also introduces several key features to enhance resilience and observability, alongside critical bug fixes and CI/CD improvements, ensuring the project's public-facing information accurately reflects its current state and capabilities. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request provides a comprehensive documentation update for the v0.8.5 release, reflecting the full migration to TypeScript and the addition of several new features. The changes are well-organized and significantly improve the clarity and accuracy of the project's documentation in README.md, CHANGELOG.md, and the architecture documents. My review includes one minor suggestion for the CHANGELOG.md to remove a redundant entry and enhance readability.
| ### Changed | ||
|
|
||
| - 📖 **Documentation update** — Updated all documentation to reflect JS → TS migration, corrected file extensions and import paths (`7ff8aa2`) | ||
| - ⬆️ **CI/CD** — Bump `actions/checkout` v4 → v6, `actions/setup-node` v4 → v6, `peter-evans/dockerhub-description` v4 → v5 |
There was a problem hiding this comment.
This line duplicates information about CI/CD dependency bumps that is already listed in the 'Dependencies' section. To keep the changelog concise and avoid redundancy, it's best to list these updates in only one section. I recommend removing this line from the 'Changed' section.
There was a problem hiding this comment.
Pull request overview
Documentation refresh for the v0.8.5 release, primarily updating docs to reflect the open-sse/ TypeScript migration and expanding/modernizing release notes and README feature/stack descriptions.
Changes:
- Updated architecture/codebase docs to replace
open-sse/*.jsreferences withopen-sse/*.ts. - Expanded README feature tables (routing, multimodal, resilience, observability, deployment) and bumped referenced Docker tag/release command to v0.8.5.
- Added a detailed v0.8.5 section to the changelog.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/CODEBASE_DOCUMENTATION.md | Updates open-sse/ file references to .ts and aligns module lists/diagrams with TS migration. |
| docs/ARCHITECTURE.md | Updates referenced open-sse/ modules from .js to .ts throughout the architecture overview. |
| README.md | Expands features/stack info and updates versioned release/Docker references for v0.8.5. |
| CHANGELOG.md | Adds a detailed v0.8.5 release section and comparison link. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - ⬆️ `actions/checkout` 4 → 6 | ||
| - ⬆️ `actions/setup-node` 4 → 6 | ||
| - ⬆️ `peter-evans/dockerhub-description` 4 → 5 | ||
| - 🚫 `eslint` 10.0.0 blocked — major version incompatible with `eslint-config-next` |
There was a problem hiding this comment.
The changelog entry “eslint 10.0.0 blocked” appears incorrect because the repo currently depends on eslint ^10.0.0. If the intent is to block a newer major (e.g., eslint 11+) or to pin eslint to a range, update this line to match the actual dependency policy/versioning.
| - 🚫 `eslint` 10.0.0 blocked — major version incompatible with `eslint-config-next` | |
| - 🚫 `eslint` 11.x blocked — major version incompatible with `eslint-config-next` |
| @@ -254,17 +292,17 @@ registerSuite({ | |||
| ## 🛠️ Tech Stack | |||
|
|
|||
| - **Runtime**: Node.js 20+ | |||
There was a problem hiding this comment.
README now states Node.js 20+ runtime, but the repo’s declared engine requirement is still >=18.0.0 (package.json). This mismatch can confuse users and tooling; either adjust the README runtime line to match the supported engines, or update package.json engines to reflect the real minimum Node version.
| - **Runtime**: Node.js 20+ | |
| - **Runtime**: Node.js 18+ (recommended: 20+) |
| | Feature | What It Does | | ||
| | ------------------------------- | ------------------------------------------------------------ | | ||
| | 🔌 **Circuit Breaker** | Auto-open/close per-provider with configurable thresholds | | ||
| | 🛡️ **Anti-Thundering Herd** | Mutex + semaphore rate-limit for API key providers | | ||
| | 🧠 **Semantic Cache** | Two-tier cache (signature + semantic) reduces cost & latency | | ||
| | ⚡ **Request Idempotency** | 5s dedup window for duplicate requests | | ||
| | 🔒 **TLS Fingerprint Spoofing** | Bypass TLS-based bot detection via wreq-js | | ||
| | 🌐 **IP Filtering** | Allowlist/blocklist for API access control | | ||
| | 📋 **Compliance Audit Log** | Tamper-proof request logs with opt-out per API key | |
There was a problem hiding this comment.
The “Compliance Audit Log” row is misleading: the codebase’s audit_log is for administrative actions (settings/apiKey/server events), not “tamper-proof request logs”. If you mean request/usage/proxy logging with per-key opt-out (noLog), consider renaming this feature or updating the description to reflect admin audit logging + per-API-key logging opt-out accurately.
| | Feature | What It Does | | |
| | ------------------------------- | ------------------------------------------------------------ | | |
| | 🔌 **Circuit Breaker** | Auto-open/close per-provider with configurable thresholds | | |
| | 🛡️ **Anti-Thundering Herd** | Mutex + semaphore rate-limit for API key providers | | |
| | 🧠 **Semantic Cache** | Two-tier cache (signature + semantic) reduces cost & latency | | |
| | ⚡ **Request Idempotency** | 5s dedup window for duplicate requests | | |
| | 🔒 **TLS Fingerprint Spoofing** | Bypass TLS-based bot detection via wreq-js | | |
| | 🌐 **IP Filtering** | Allowlist/blocklist for API access control | | |
| | 📋 **Compliance Audit Log** | Tamper-proof request logs with opt-out per API key | | |
| | Feature | What It Does | | |
| | ------------------------------- | ---------------------------------------------------------------------------- | | |
| | 🔌 **Circuit Breaker** | Auto-open/close per-provider with configurable thresholds | | |
| | 🛡️ **Anti-Thundering Herd** | Mutex + semaphore rate-limit for API key providers | | |
| | 🧠 **Semantic Cache** | Two-tier cache (signature + semantic) reduces cost & latency | | |
| | ⚡ **Request Idempotency** | 5s dedup window for duplicate requests | | |
| | 🔒 **TLS Fingerprint Spoofing** | Bypass TLS-based bot detection via wreq-js | | |
| | 🌐 **IP Filtering** | Allowlist/blocklist for API access control | | |
| | 📋 **Admin Audit Log & Log Opt-out** | Immutable log of admin actions (settings/API keys/server events) + per-API-key opt-out for request/proxy logging | |
…HoverCard dependency Kit 0.0.87 (upstream #63/#70) announces each toast once through two persistent live regions, assertive for errors and polite for the rest, so the announcement survives a modal dialog; the toast cards no longer carry role=alert or role=status. The NotificationToast bridge tests now check the visible card (text, variant, position, removal, no duplicates, the Open action) and the announcement in the right region, including that both regions stay exposed while a Modal is open. @radix-ui/react-hover-card joins config/quality/dependency-allowlist.json with its justification, so check:deps and its unit test accept the kit's new runtime dependency.
* chore(dashboard): sync the vendored CI UI Kit to 0.0.87 packages/ui-kit moves from upstream deb522b to 681cdb1 (0.0.87) through scripts/dev/sync-ui-kit.sh. * fix(dashboard): load the complete kit stylesheet and add the kit's new HoverCard dependency Kit 0.0.87 splits the pattern families out of ci-ui.css (upstream #133): ci-ui.css is now the core sheet, and the wizard, onboarding, announcement, integration, overview, request-workbench and Cloud families live in their own sheets. The complete sheet is ci-styles.css, which is what the package exports as ./styles.css. The dashboard uses components from those families (the batch and pool wizards, onboarding, the Cloud agents pages), so globals.css now imports ci-styles.css and the workspace's ./styles.css export points at it, mirroring the upstream package. HoverCard (upstream #123) imports @radix-ui/react-hover-card, which the sync script doesn't add, so it joins the root dependencies, pinned exactly like the other Radix packages. The local recharts patch in PATCHES.md is dropped: upstream #149 shipped the same graphicalItemId fix in reporting-charts.tsx, so the snapshot is byte for byte again. The DESIGN_SYSTEM mirrors are refreshed for the import path: 53 through the structure-safe Google engine, the 13 it could not restore through the LLM backend. * test(dashboard): follow the kit Toaster's live regions and allow the HoverCard dependency Kit 0.0.87 (upstream #63/#70) announces each toast once through two persistent live regions, assertive for errors and polite for the rest, so the announcement survives a modal dialog; the toast cards no longer carry role=alert or role=status. The NotificationToast bridge tests now check the visible card (text, variant, position, removal, no duplicates, the Open action) and the announcement in the right region, including that both regions stay exposed while a Modal is open. @radix-ui/react-hover-card joins config/quality/dependency-allowlist.json with its justification, so check:deps and its unit test accept the kit's new runtime dependency. --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Summary
Complete documentation update for v0.8.5 release.
README.md
CHANGELOG.md
ARCHITECTURE.md & CODEBASE_DOCUMENTATION.md
.js→.tsfile references for open-sse/ migration