docs: use repo icon and Pipery org avatar in README#5
Conversation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to replace generic icons with Pipery-branded assets. The review feedback recommends using relative paths for local assets to ensure they render correctly across branches and suggests using a vanity URL for the GitHub avatar to improve code readability and maintainability.
| @@ -1,4 +1,4 @@ | |||
| # <img src="https://raw.githubusercontent.com/feathericons/feather/master/icons/code.svg" width="28" align="center" /> Pipery Python CI | |||
| # <img src="https://raw.githubusercontent.com/pipery-dev/pipery-python-ci/main/assets/icon.png" width="28" align="center" /> Pipery Python CI | |||
There was a problem hiding this comment.
Using a relative path for the repository icon is preferred over a hardcoded absolute URL pointing to the main branch. This ensures the icon renders correctly across different branches and forks, and remains functional if the default branch name is changed.
| # <img src="https://raw.githubusercontent.com/pipery-dev/pipery-python-ci/main/assets/icon.png" width="28" align="center" /> Pipery Python CI | |
| # <img src="assets/icon.png" width="28" align="center" /> Pipery Python CI |
| ## About Pipery | ||
|
|
||
| <img src="https://raw.githubusercontent.com/feathericons/feather/master/icons/zap.svg" width="18" align="center" /> [**Pipery**](https://pipery.dev) is an open-source CI/CD observability platform. Every step script runs under **psh** (Pipery Shell), which intercepts all commands and emits structured JSONL events — giving you full visibility into your pipeline without any manual instrumentation. | ||
| <img src="https://avatars.githubusercontent.com/u/270923927?s=32" width="22" align="center" /> [**Pipery**](https://pipery.dev) is an open-source CI/CD observability platform. Every step script runs under **psh** (Pipery Shell), which intercepts all commands and emits structured JSONL events — giving you full visibility into your pipeline without any manual instrumentation. |
There was a problem hiding this comment.
The avatar URL uses a hardcoded numeric user ID. Using the organization's vanity URL (e.g., https://github.com/pipery-dev.png) is more readable and maintainable, as it clearly identifies the organization in the source code.
| <img src="https://avatars.githubusercontent.com/u/270923927?s=32" width="22" align="center" /> [**Pipery**](https://pipery.dev) is an open-source CI/CD observability platform. Every step script runs under **psh** (Pipery Shell), which intercepts all commands and emits structured JSONL events — giving you full visibility into your pipeline without any manual instrumentation. | |
| <img src="https://github.com/pipery-dev.png?s=32" width="22" align="center" /> [**Pipery**](https://pipery.dev) is an open-source CI/CD observability platform. Every step script runs under **psh** (Pipery Shell), which intercepts all commands and emits structured JSONL events — giving you full visibility into your pipeline without any manual instrumentation. |
1 participant
Replace generic Feather icon SVGs with repo-specific
assets/icon.pngand Pipery org avatar.