Skip to content

chore: move README images to assets/ and polish the confirmation docs - #41

Merged
divyanshub024 merged 2 commits into
mainfrom
chore/confirmation-follow-ups
Sep 1, 2026
Merged

chore: move README images to assets/ and polish the confirmation docs#41
divyanshub024 merged 2 commits into
mainfrom
chore/confirmation-follow-ups

Conversation

@divyanshub024

@divyanshub024 divyanshub024 commented Sep 1, 2026

Copy link
Copy Markdown
Member

Summary

Two small follow-ups to #40.

  • Renames doc/ to assets/ to match the org convention (the stac repo keeps its README images in assets/) and updates the two README references. History is preserved through git mv.
  • Rewrites the confirmation docs page's frontmatter description ("The approval card for gated actions: a host-written request with approve and reject buttons that report intent, then settle into the outcome") and replaces the page's em dashes with colons, semicolons, parentheses, or sentence breaks. The description is quoted because the new colon would otherwise break the YAML frontmatter.

How this was verified

  • npm run build in docs/ completes cleanly (the unquoted colon reproduced the frontmatter failure first).
  • README image references checked against the renamed paths; nothing else in the repo referenced doc/.

Checklist

  • flutter analyze lib and flutter analyze in example/ and playground/ are clean
  • dart format . applied
  • Exercised in the playground — with a stage demo added or updated if this is a new component or variant (not applicable: no Dart changes)
  • No new entries under dependencies: in pubspec.yaml (Flutter SDK and flutter.dev packages only)
  • Nothing model-facing — no prompts, schemas, or provider/network calls
  • New public API is exported from lib/flow_ui.dart and documented in docs/ and the README table (not applicable: no API changes)
  • CHANGELOG.md updated for user-facing changes, with breaking changes called out (not applicable: repo housekeeping and docs wording)
  • PR title follows conventional commits (feat:, fix:, refactor:, docs:, chore:)

Note

Low Risk
Documentation and README asset paths only; no runtime or public API impact.

Overview
README image URLs now point at assets/ instead of doc/ (logo and chat screenshot), aligning with the org’s convention after the folder rename.

Confirmation docs get a clearer, quoted frontmatter description (so YAML stays valid with the new colon) and copy edits that swap em dashes for colons, semicolons, and parentheses—same meaning, no API changes.

Reviewed by Cursor Bugbot for commit ab80cd6. Bugbot is set up for automated code reviews on this repo. Configure here.

@divyanshub024
divyanshub024 merged commit ae88435 into main Sep 1, 2026
5 checks passed
@divyanshub024
divyanshub024 deleted the chore/confirmation-follow-ups branch September 1, 2026 19:44

@cursor cursor Bot 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.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit ab80cd6. Configure here.

Comment thread README.md
</p>

![The flow_ui chat surface](doc/chat_zero_light.png)
![The flow_ui chat surface](assets/chat_zero_light.png)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Stale pubignore path for screenshots

Low Severity

README screenshots now live under assets/, but .pubignore still excludes doc/ as the repo-only screenshot folder. The logo and chat image will therefore enter the published archive, even though that ignore file exists so pub.dev loads them from the repository instead.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit ab80cd6. Configure here.

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.

1 participant