Skip to content

docs: refresh README (automated audit) - #2

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

docs: refresh README (automated audit)#2
rustyorb wants to merge 1 commit into
mainfrom
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

Documentation:

  • Rewrite the README with a clearer product-focused description, detailed tech stack, usage instructions, available scripts, configuration notes, and project structure, and update the license section to note that no license file is currently included.

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

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.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@sourcery-ai

sourcery-ai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Reviewer's Guide

Refreshes and expands README.md to provide a clearer, more detailed description of the App Spec Generator tool, including features, tech stack, usage, scripts, project structure, client-side API key handling, and licensing status.

File-Level Changes

Change Details Files
Rewrite and expand the README to give a more complete overview of the app, how it works, and how to run it.
  • Replace the generic title and short description with a focused description of the App Spec Generator and its use of the Claude API.
  • Elaborate the feature list to describe the structure and scope of generated specifications and how the Anthropic API key is stored client-side.
  • Add a detailed tech stack table covering build, framework, styling, components, forms, routing, data fetching, and AI SDK.
  • Clarify prerequisites, including supported Node version, npm/Bun, and where to obtain an Anthropic API key.
  • Refine usage instructions to walk through starting the dev server, setting/saving/removing the API key in localStorage, and streaming spec generation with a specific Claude model.
  • Document available npm scripts and what each command does.
  • Add a project structure diagram explaining key directories and files such as components, hooks, utils, pages, and entry points.
  • Replace the previous MIT license reference with an explicit statement that no license file is present and that rights are reserved until a license is added.
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