Skip to content

docs: add uinaf banner to the readme - #16

Closed
altaywtf wants to merge 0 commit into
mainfrom
docs/readme-banner
Closed

docs: add uinaf banner to the readme#16
altaywtf wants to merge 0 commit into
mainfrom
docs/readme-banner

Conversation

@altaywtf

@altaywtf altaywtf commented Aug 2, 2026

Copy link
Copy Markdown
Member

Adds the uinaf banner to the top of the README.

The image is generated at build time from this repo's own GitHub metadata (description, latest release, language, licence) and served from uinaf.dev, so it stays current without another PR here.

Review aid: https://uinaf.dev/og/banner/workspace-kit.png

🤖 Generated with Claude Code


Summary by cubic

Adds a dynamic banner at the top of the README that displays repo info (description, latest release, language, license) and stays up to date via uinaf.dev. Uses an empty alt so screen readers skip the decorative image, since the repo name and description follow immediately.

Written for commit aab671f. Summary will update on new commits.

Summary by CodeRabbit

  • Documentation
    • Added a banner image link to the top of the README.

Copilot AI review requested due to automatic review settings August 2, 2026 19:21
@coderabbitai

coderabbitai Bot commented Aug 2, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The README now includes a workspace-kit banner image linked to the project’s Open Graph banner.

Changes

README presentation

Layer / File(s) Summary
Add README banner
README.md
The README adds a workspace-kit banner image and links it to the project’s Open Graph banner.

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

Poem

A rabbit hops through README light,
A banner blooms at top in sight.
One click links the project’s face,
Neat and bright in its new place.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the banner change but omits the required Changed, Risks, Verification, and Complexity sections. Add the required template sections and provide concise details for the changed files, risks, verification steps, and implementation complexity.
✅ Passed checks (4 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 clearly identifies the main change: adding a Uinaf banner to the README.

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

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

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.

Pull request overview

Adds a README header banner image that displays current repository metadata (description, latest release, language, license) via a generated image hosted on uinaf.dev.

Changes:

  • Inserted a banner image at the very top of README.md.
  • Kept existing README structure/content intact (title and sections unchanged).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@altaywtf altaywtf closed this Aug 3, 2026
@altaywtf
altaywtf force-pushed the docs/readme-banner branch from 164e9b2 to aab671f Compare August 3, 2026 11:44
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