Skip to content

docs: remove README placeholder screenshot - #324

Merged
Astro-Han merged 1 commit into
devfrom
docs/remove-readme-placeholder
Apr 29, 2026
Merged

docs: remove README placeholder screenshot#324
Astro-Han merged 1 commit into
devfrom
docs/remove-readme-placeholder

Conversation

@Astro-Han

@Astro-Han Astro-Han commented Apr 29, 2026

Copy link
Copy Markdown
Owner

Summary

Removes the remaining README session screenshot placeholder from the English and Chinese README files.

Deletes the unused placeholder SVG asset.

Why

PR #322 merged with the real homepage screenshot, but the session screenshot placeholder was still present. This follow-up removes the placeholder until there is a real session screenshot to add.

Related Issue

Follow-up to #322.

How To Verify

git diff --check origin/dev..HEAD
rg -n "placeholder|占位|pawwork-session" README.md README_CN.md assets/readme || true

No runtime tests were run because this is a documentation-only cleanup.

Screenshots or Recordings

Not applicable. This PR removes a placeholder image and keeps the existing real homepage screenshot.

Checklist

  • I linked the related issue, or stated why there is no issue
  • This PR has type, scope, and priority labels, or I requested maintainer labeling
  • I listed the relevant verification steps, including tests when behavior changed
  • I manually checked visible UI or copy changes when needed, with screenshots or recordings
  • I considered macOS and Windows impact for desktop, packaging, updater, signing, paths, shell, or permissions changes
  • I called out docs, release notes, dependencies, permissions, credentials, deletion behavior, or generated/local file changes when relevant
  • I am targeting dev, and my PR title and commit messages use Conventional Commits in English

Summary by CodeRabbit

  • Documentation
    • Removed placeholder image reference from the main README
    • Removed placeholder image reference from the Chinese README documentation

@coderabbitai

coderabbitai Bot commented Apr 29, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: ac271a45-400e-4f18-a498-8b2f16cae101

📥 Commits

Reviewing files that changed from the base of the PR and between 676dd60 and 498562f.

⛔ Files ignored due to path filters (1)
  • assets/readme/pawwork-session.svg is excluded by !**/*.svg
📒 Files selected for processing (2)
  • README.md
  • README_CN.md
💤 Files with no reviewable changes (2)
  • README.md
  • README_CN.md
📜 Recent review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)
  • GitHub Check: smoke-macos-arm64
  • GitHub Check: unit-windows-opencode-config-project
  • GitHub Check: unit-opencode
  • GitHub Check: unit-windows-app
  • GitHub Check: unit-windows-opencode-session
  • GitHub Check: unit-windows-opencode-server-tools
  • GitHub Check: unit-windows-desktop
  • GitHub Check: unit-desktop
  • GitHub Check: unit-app
  • GitHub Check: typecheck
  • GitHub Check: e2e-artifacts
  • GitHub Check: analyze-js-ts

📝 Walkthrough

Walkthrough

This pull request removes placeholder image references from both the English and Chinese README files, specifically deleting two lines that referenced a "PawWork session screen placeholder" image section.

Changes

Cohort / File(s) Summary
Documentation cleanup
README.md, README_CN.md
Removes placeholder session screen image references from documentation files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

documentation, P3, app

Poem

🐰 A little hop, a little skip,
We clean the docs, no placeholder trip!
Session shadows fade away,
Cleaner READMEs brighten the day! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: removing a README placeholder screenshot. It directly relates to the primary objective of the PR.
Description check ✅ Passed The description comprehensively follows the template with all required sections: Summary, Why, Related Issue, How To Verify, Screenshots or Recordings, and a completed Checklist.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/remove-readme-placeholder

Review rate limit: 2/3 reviews remaining, refill in 20 minutes.

Comment @coderabbitai help to get the list of available commands and usage tips.

@Astro-Han Astro-Han added documentation Improvements or additions to documentation app Application behavior and product flows P3 Low priority labels Apr 29, 2026

@gemini-code-assist gemini-code-assist 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.

Code Review

This pull request removes the pawwork-session.svg placeholder image and its corresponding references from both the English and Chinese README files. I have no feedback to provide as there are no review comments.

@Astro-Han
Astro-Han merged commit 509d448 into dev Apr 29, 2026
26 checks passed
@Astro-Han
Astro-Han deleted the docs/remove-readme-placeholder branch April 29, 2026 09:12
@coderabbitai coderabbitai Bot mentioned this pull request Apr 30, 2026
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

app Application behavior and product flows documentation Improvements or additions to documentation P3 Low priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant