Skip to content

docs: update README cover and CI filter - #350

Merged
Astro-Han merged 2 commits into
devfrom
codex/docs-readme-cover
May 1, 2026
Merged

docs: update README cover and CI filter#350
Astro-Han merged 2 commits into
devfrom
codex/docs-readme-cover

Conversation

@Astro-Han

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

Copy link
Copy Markdown
Owner

Summary

Replace the README hero image with a new PawWork branded cover generated with imagegen from the real app logo. Update both English and Chinese README files to reference the new cover asset.

Why

The existing README image was a plain home screenshot and did not work well as the first visual impression for the project. The new cover aligns with the current README and repository About positioning: an open-source AI agent that works out of the box on your desktop.

Related Issue

No related issue. This is a small documentation and visual asset update.

Human Review Status

Pending. A human should make the final merge decision after reviewing the final diff and verification evidence.

Review Focus

Please check whether the cover image fits the README first-screen positioning and whether the bilingual README alt text is appropriate.

Risk Notes

Low risk. This only changes README image references and adds a static image asset. No runtime, dependency, packaging, permission, or platform behavior changes.

How To Verify

Image dimensions: assets/readme/pawwork-cover.png is 1586x992 PNG
README references: README.md and README_CN.md both point to assets/readme/pawwork-cover.png
Diff review: staged diff contained only README image reference changes plus the new cover image

Screenshots or Recordings

New README cover:

PawWork README cover

Checklist

  • Human review status is stated above as pending, approved, or not required
  • 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 described the review focus and any meaningful risks
  • I listed the relevant verification steps and the key result for each
  • I did not introduce unrelated refactors, dependencies, generated files, or file changes beyond the stated scope
  • 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, generated content, or local file changes when relevant
  • I reviewed the final diff for unrelated changes and suspicious dependency changes
  • I am targeting dev, and my PR title and commit messages use Conventional Commits in English

Summary by CodeRabbit

  • Documentation

    • Updated the cover image and its alt text in the project documentation (English and Chinese) to improve the landing/hero preview.
  • Chores

    • CI/workflow logic updated so README/cover asset edits are treated as documentation-only; heavyweight analysis and some test/artifact jobs are skipped when only docs change.

@Astro-Han Astro-Han added documentation Improvements or additions to documentation P3 Low priority ui Design system and user interface labels Apr 30, 2026
@coderabbitai

coderabbitai Bot commented Apr 30, 2026

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Replaced the hero/cover image reference and alt text in English and Chinese READMEs, and updated multiple GitHub Actions workflows to treat assets/readme/* as documentation-only (adding a changes job and gating analysis/jobs on its docs_only output).

Changes

Cohort / File(s) Summary
README Files
README.md, README_CN.md
Swapped hero image asset from assets/readme/pawwork-home.png to assets/readme/pawwork-cover.png and updated alt text.
CI workflows — docs-only detection
.github/workflows/ci.yml, .github/workflows/desktop-smoke.yml, .github/workflows/e2e-artifacts.yml
Extended docs-only path checks to include assets/readme/*, so changes under that path produce docs_only=true and can skip downstream jobs.
CodeQL workflow
.github/workflows/codeql.yml
Added a preliminary changes job that outputs docs_only (based on changed paths) and gated analyze-js-ts with needs: changes plus an if so analysis runs only when docs_only != 'true'; ensures workflow_dispatch forces docs_only=false.

Sequence Diagram(s)

sequenceDiagram
participant PR as "Pull Request"
participant Changes as "ci:changes job"
participant CI as "CI jobs (typecheck/tests/e2e/desktop)"
participant CodeQL as "CodeQL analyze job"

PR->>Changes: compute changed paths & determine docs_only
alt docs_only == 'true'
    Changes-->>PR: docs_only = 'true'
    Changes->>CI: mark downstream jobs to skip
    CI-->>PR: skip non-docs jobs
else docs_only != 'true'
    Changes-->>PR: docs_only = 'false'
    Changes->>CodeQL: allow analysis (needs satisfied)
    CodeQL->>CI: analysis results
    CI->>PR: run/full CI
end
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested labels

ci

Poem

🐰📸 A tiny swap, a brighter frame,
READMEs hum a softer name.
Workflows learn what pictures mean,
Docs-only hops — serene, unseen. 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title 'docs: update README cover and CI filter' accurately summarizes the main change: updating README documentation with a new cover image and adjusting CI workflows to filter docs-only changes.
Description check ✅ Passed The PR description comprehensively covers all template sections: Summary, Why, Related Issue, Human Review Status, Review Focus, Risk Notes, How To Verify with specific test results, Screenshots, and a completed Checklist. All critical information is present and well-documented.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/docs-readme-cover

Warning

Review ran into problems

🔥 Problems

Timed out fetching pipeline failures after 30000ms


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

@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 updates the cover image asset and its associated alt text in both the English and Chinese README files. The review feedback suggests improving accessibility by using more descriptive alt text that conveys the product's value proposition rather than just labeling the image as a cover.

Comment thread README.md Outdated
Comment thread README_CN.md Outdated
@Astro-Han
Astro-Han force-pushed the codex/docs-readme-cover branch from e5958a7 to d5f43b3 Compare April 30, 2026 16:38
@Astro-Han Astro-Han changed the title docs: update README cover docs: update README cover and CI filter Apr 30, 2026
@Astro-Han Astro-Han added ci Continuous integration / GitHub Actions github_actions Pull requests that update GitHub Actions code labels Apr 30, 2026
@Astro-Han
Astro-Han merged commit 4d6e7e5 into dev May 1, 2026
28 checks passed
@Astro-Han
Astro-Han deleted the codex/docs-readme-cover branch May 1, 2026 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Continuous integration / GitHub Actions documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code P3 Low priority ui Design system and user interface

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant