Skip to content

docs: refresh README (automated audit) - #1

Closed
rustyorb wants to merge 1 commit into
masterfrom
chore/readme-audit
Closed

docs: refresh README (automated audit)#1
rustyorb wants to merge 1 commit into
masterfrom
chore/readme-audit

Conversation

@rustyorb

@rustyorb rustyorb commented Jul 20, 2026

Copy link
Copy Markdown
Owner

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:

  • Add descriptions of The Atlas procedural world map and Workflow Forge integrations for local ComfyUI and Automatic1111 workflows to the feature list.
  • Update the tech stack section to include React Router and explain that all cloud model calls and local image generation are handled client-side without a dedicated backend.

Copilot AI review requested due to automatic review settings July 20, 2026 01:03

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread README.md
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.
@sourcery-ai

sourcery-ai Bot commented Jul 20, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

README 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 workflow

sequenceDiagram
    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
Loading

File-Level Changes

Change Details Files
Document new Atlas and Workflow Forge features in the feature list table.
  • Add Atlas feature row describing procedurally generated maps, pinned locations, AI-invented places, and PNG export.
  • Add Workflow Forge feature row describing integration with local ComfyUI and Automatic1111 backends, workflow assembly/validation, and use of dev-server proxies to avoid CORS setup.
README.md
Clarify and expand the tech stack and architecture description.
  • Add React Router to the listed front-end tech stack.
  • Add explanatory paragraph that cloud model calls are made directly from the browser to providers and that local image generation uses ComfyUI/Automatic1111 via Vite dev-server proxies, emphasizing the absence of a custom backend.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@rustyorb

Copy link
Copy Markdown
Owner Author

🪦⚡🌹 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.

@rustyorb rustyorb closed this Jul 21, 2026
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