Skip to content

Add logo to README for visual enhancement #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sourcehawk merged 1 commit into from
Apr 2, 2026
Merged

Add logo to README for visual enhancement #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
A Go framework for building highly maintainable Kubernetes operators using a behavioral component model and
version-gated feature mutations.

<p align="center">
<img width="400" height="400" alt="OCF Logo" src="https://github.com/user-attachments/assets/ac8162e7-5963-4284-a590-5a9215090103" />
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

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

The logo is referenced via a github.com/user-attachments/assets/... URL. These attachment URLs aren’t a stable, versioned project asset and can break or become inaccessible; consider committing the logo into the repo (e.g., docs/assets/logo.png or .github/assets/) and referencing it via a relative path or raw GitHub URL so it’s durable and works offline/forked copies.

Suggested change
<img width="400" height="400" alt="OCF Logo" src="https://github.com/user-attachments/assets/ac8162e7-5963-4284-a590-5a9215090103" />
<img width="400" height="400" alt="OCF Logo" src="docs/assets/logo.png" />

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

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

The image hard-codes both width and height to 400px, which can distort the logo if the source isn’t perfectly square and doesn’t adapt well on small screens. Prefer specifying only one dimension (or using style="max-width: ...; height: auto") so the aspect ratio is preserved and the README remains responsive.

Suggested change
<img width="400" height="400" alt="OCF Logo" src="https://github.com/user-attachments/assets/ac8162e7-5963-4284-a590-5a9215090103" />
<img alt="OCF Logo" src="https://github.com/user-attachments/assets/ac8162e7-5963-4284-a590-5a9215090103" style="max-width: 400px; width: 100%; height: auto;" />

Copilot uses AI. Check for mistakes.
</p>

---

Comment on lines +10 to 15
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

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

This adds raw HTML (<p align=...><img .../>) to the README; the rest of the repo’s markdown docs appear to avoid embedded HTML. Consider using standard Markdown image syntax instead (and center it only if necessary) to improve portability across renderers (e.g., pkg.go.dev) and keep documentation style consistent.

Suggested change
<p align="center">
<img width="400" height="400" alt="OCF Logo" src="https://github.com/user-attachments/assets/ac8162e7-5963-4284-a590-5a9215090103" />
</p>
---
![OCF Logo](https://github.com/user-attachments/assets/ac8162e7-5963-4284-a590-5a9215090103)
---

Copilot uses AI. Check for mistakes.
The framework is organized into three composable layers:
Expand Down
Loading