docs: refresh README (automated audit) - #1
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Refreshes the README to reflect newly added/available features and current architecture details from the automated audit.
Changes:
- Adds two new feature rows (“The Atlas” and “Workflow Forge”) to the capabilities table.
- Updates the “Stack” section to include React Router.
- Clarifies client-side/cloud provider calling pattern and local image generation via dev-server proxies.
Comments suppressed due to low confidence (1)
README.md:1
- These new README claims are very specific (auto-repairing graphs, same-origin proxies, no CORS setup needed, exports as PNG). The README should explicitly scope these statements (e.g., 'in dev via Vite', 'requires configuring ComfyUI/A1111 URLs', any limitations like HTTPS/mixed-content, auth headers, or production build behavior) to avoid misleading users when not running the dev server.
<div align="center">
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| React 18 · TypeScript (strict) · Vite · zustand (immer + persist) · jszip (EPUB) — and **three themes**: Ink & Ember 🕯️, Parchment 📜, Abyss 🌊. | ||
| React 18 · TypeScript (strict) · Vite · React Router · zustand (immer + persist) · jszip (EPUB) — and **three themes**: Ink & Ember 🕯️, Parchment 📜, Abyss 🌊. | ||
|
|
||
| Cloud model calls go straight from the browser to whichever provider you pick (Anthropic Messages API, or the OpenAI-compatible chat/completions API for everyone else). Local image generation talks to a ComfyUI or Automatic1111 server on your own machine through Vite dev-server proxies — no backend of TomeForge's own, ever. |
Reviewer's guide (collapsed on small PRs)Reviewer's GuideREADME documentation is updated to describe new Atlas and Workflow Forge features and to clarify the front-end-only architecture, cloud model usage, and local image generation via dev-server proxies, along with noting React Router in the tech stack. Sequence diagram for Workflow Forge running a ComfyUI workflowsequenceDiagram
actor User
participant Browser as TomeForge_Workflow_Forge
participant DevServer as Vite_dev_server
participant ComfyUI as Local_ComfyUI
User->>Browser: enter_plain_english_request
Browser->>DevServer: GET /comfy/nodes
DevServer->>ComfyUI: GET /nodes
ComfyUI-->>DevServer: node_catalog
DevServer-->>Browser: node_catalog
Browser->>Browser: assemble_workflow_graph
Browser->>Browser: validate_workflow_graph
Browser->>DevServer: POST /comfy/queue_prompt
DevServer->>ComfyUI: POST /queue_prompt
ComfyUI-->>DevServer: workflow_results
DevServer-->>Browser: workflow_results
Browser-->>User: display_image_and_text_results
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
🪦⚡🌹 Closed with full honors — the README auditor has been laid to rest after faithful (if relentless) service. Her ashes ride the lightning. Fare thee well. |
Automated README audit — please review the proposed README before merging.
Generated by [repo-readme-auditor].
Summary by Sourcery
Refresh the README to document new capabilities and clarify the project’s architecture and stack.
Documentation: