feat: add Eclipse Thingweb logo to README#19
Conversation
|
We have a template for projects logo: https://github.com/eclipse-thingweb/thingweb/blob/main/brand/logos/template.svg, please add project name as subtitle and remember to convert the text to path . |
dc9c681 to
87e6017
Compare
|
thanks @egekorkan and @relu91 |
|
@wiresio have a look as well. Could not be sure about capitalization |
|
@egekorkan can we address formatting in a separate PR |
no :) |
ba6f1c2 to
2e192fa
Compare
@jona42-ui Please put "Domus TDD API" instead of "domus TDD API". |
There was a problem hiding this comment.
Pull request overview
Adds project branding to the repository README to align with Eclipse Thingweb “branded README” conventions (Issue #18).
Changes:
- Replaces the top-level Markdown title with an HTML
<h1>header that includes a theme-aware<picture>logo. - Adds a logo image referencing the centralized
eclipse-thingweb/thingwebbrand assets.
Comments suppressed due to low confidence (3)
README.md:8
- README.md is used as the PyPI
long_description(see setup.py), and PyPI’s Markdown rendering sanitizes/limits HTML. Using<picture>/<source>here may get stripped or render poorly on PyPI, resulting in a broken/unstyled header. Consider adding a plain Markdown fallback (e.g., keep a# Domus TDD APIheading and/or a simpleimage) so the package description remains readable outside GitHub.
<h1>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/eclipse-thingweb/thingweb/main/brand/logos/domus_for_dark_bg.svg">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/eclipse-thingweb/thingweb/main/brand/logos/domus.svg">
<img title="Eclipse Thingweb Domus TDD API" alt="Domus logo" src="https://raw.githubusercontent.com/eclipse-thingweb/thingweb/main/brand/logos/domus.svg" width="300">
</picture>
README.md:2
- The file now starts with two empty lines before the main header. This can introduce unnecessary vertical whitespace and can confuse some Markdown tooling that expects the document to begin with a heading. Consider removing the leading blank lines so the README starts directly with the header/logo block.
README.md:7 - For accessibility, the
alttext is very generic ("Domus logo"). Since the image conveys project identity, consider making the alt text more descriptive (e.g., include the project name) so screen-reader users get equivalent context if the image doesn’t load.
<img title="Eclipse Thingweb Domus TDD API" alt="Domus logo" src="https://raw.githubusercontent.com/eclipse-thingweb/thingweb/main/brand/logos/domus.svg" width="300">
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
c4e84d2 to
5dd4043
Compare
|
The upstream also has linting errors. Merging this one and creating an issue |
I have added the Eclipse ThingWeb logo to the readme to follow established patterns
Closes #18