Skip to content

feat: add Eclipse Thingweb logo to README#19

Merged
egekorkan merged 1 commit intoeclipse-thingweb:mainfrom
jona42-ui:add-logo-to-readme
Mar 4, 2026
Merged

feat: add Eclipse Thingweb logo to README#19
egekorkan merged 1 commit intoeclipse-thingweb:mainfrom
jona42-ui:add-logo-to-readme

Conversation

@jona42-ui
Copy link
Copy Markdown
Contributor

I have added the Eclipse ThingWeb logo to the readme to follow established patterns

Closes #18

@relu91
Copy link
Copy Markdown
Member

relu91 commented Feb 27, 2026

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 .

@egekorkan
Copy link
Copy Markdown
Member

We have domus logos as well:

Comment thread README.md Outdated
@jona42-ui
Copy link
Copy Markdown
Contributor Author

thanks @egekorkan and @relu91

@egekorkan egekorkan requested a review from wiresio February 27, 2026 17:33
@egekorkan
Copy link
Copy Markdown
Member

@wiresio have a look as well. Could not be sure about capitalization

@jona42-ui
Copy link
Copy Markdown
Contributor Author

@egekorkan can we address formatting in a separate PR

@egekorkan
Copy link
Copy Markdown
Member

@egekorkan can we address formatting in a separate PR

no :)

@wiresio
Copy link
Copy Markdown
Member

wiresio commented Mar 2, 2026

@wiresio have a look as well. Could not be sure about capitalization

@jona42-ui Please put "Domus TDD API" instead of "domus TDD API".

Copilot AI review requested due to automatic review settings March 2, 2026 10:16
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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/thingweb brand 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 API heading and/or a simple ![logo](...) image) 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 alt text 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.

@jona42-ui jona42-ui force-pushed the add-logo-to-readme branch from c4e84d2 to 5dd4043 Compare March 2, 2026 10:53
@egekorkan
Copy link
Copy Markdown
Member

The upstream also has linting errors. Merging this one and creating an issue

@egekorkan egekorkan merged commit 64699ab into eclipse-thingweb:main Mar 4, 2026
2 of 3 checks passed
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.

Adding logo to readme

5 participants