Skip to content

docs(brand): add contextual Dash repository illustration - #1

Open
coisa wants to merge 7 commits into
mainfrom
codex/dash-readme
Open

coisa wants to merge 7 commits into
mainfrom
codex/dash-readme

Conversation

@coisa

@coisa coisa commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

Add contextual Dash artwork showing Dash comparing a running clock with a frozen clock in docs/_static/mascot-banner.png and display its relative path from the README at width 840. Exclude /docs/ and root /README*.md files from package archives together.

Validation: PNG structure, 1536 x 1024 dimensions and SHA-256 verified; git archive contains no docs or root README Markdown; README path and alt text match; git diff --check passed.
No runtime PHP code changed.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-05T18:16:58.176788Z c0346a0 New commits
🔒 Security Review ✅ Completed 2026-10-05T18:17:48.008462Z c0346a0 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 0cfbe4fd-e2bd-483b-895c-8dd34be86b64
📥 Commits

Reviewing files that changed from the base of the PR and between 30c50f0 and f41b048.

⛔ Files ignored due to path filters (1)
  • docs/_static/mascot-banner.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • .gitattributes
  • README.md
  • assets/brand/README.md
  • docs/_static/mascot-banner.receipt.json

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Added a centered Dash logo beneath the README title, displayed at 840 pixels wide with descriptive alternative text.
    • Added documentation describing the artwork’s history, approved use, and rights limitations, along with a receipt recording its generation and review details.
  • Chores
    • Excluded brand assets and the mascot banner and its receipt from exported archives.

Walkthrough

The README displays a centered Dash logo at 840 pixels wide. Brand documentation and a JSON receipt record the image’s provenance, publication authorization, and rights statements. Git export excludes the brand directory and two documentation files.

Changes

Dash README image

Layer / File(s) Summary
Banner publication and asset records
README.md, assets/brand/README.md, docs/_static/mascot-banner.receipt.json, .gitattributes
The README displays the banner at 840 pixels wide. The brand README and JSON receipt document its provenance, publication authorization, and rights statements. Git export excludes /assets/brand/ and the two listed documentation files.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to f41b0

The README points to the matching banner, and the publication records and tested archive behavior are consistent. A post-merge image-link failure was not established, so no concrete merge-blocking risk remains.

Architecture Summary

Architecture risk: 🔵 Low · up to f41b0

The change affects 3 systems.

Changed systems: assets, docs, README.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — assets (service) was modified; 1 changed file maps to changed impact.
  • observed — docs (service) was modified; 1 changed file maps to changed impact.
  • observed — README.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in README.md: Added a centered logo image with descriptive alternative text and a width of 840 pixels.
  • observed — Modified behavior in assets/brand/README.md: Identifies the contextual illustration and its local path, explains the root README’s immutable-commit URL versus the documentation path, and captions the clock scene.
  • observed — Modified behavior in assets/brand/README.md: Records the superseded welcome-copy history and the commits used for the current clock scene, describes its visual comparison with the approved welcome master, and links the generation receipt and canonical brand kit.
  • observed — Modified behavior in assets/brand/README.md: Records the maintainer’s dated authorization for public README and documentation use, states that historical source-art rights are unrecorded, and disclaims an independent asset license or extension of the software license to the image.
🚥 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. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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 clearly describes the addition of contextual Dash artwork, which is the pull request’s main change.
Description check ✅ Passed The description explains the artwork, its README use, archive exclusions, and validation. It is related to the changeset.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

A rabbit found a banner bright
And placed it neatly in the README
Its history sits beside the art
While export leaves the source apart
Then hops away beneath the clock!

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

@coisa coisa changed the title docs: align README with approved Dash identity docs(brand): add contextual Dash repository illustration Oct 5, 2026

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b0744dd91b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment thread docs/_static/mascot-banner.receipt.json Outdated
Comment thread docs/_static/mascot-banner.receipt.json Outdated

This branch has not been deployed

No deployments
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