docs: update README with branding images#1148
Conversation
Signed-off-by: Ron <45816308+rjaegers@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the repository README to add a branded header with a linked logo at the top for improved visual presentation.
Changes:
- Added an HTML header block with a linked logo image at the top of
README.md - Added markdownlint disable/enable markers around the new header block
✅
|
| Descriptor | Linter | Files | Fixed | Errors | Warnings | Elapsed time |
|---|---|---|---|---|---|---|
| ✅ ACTION | actionlint | 21 | 0 | 0 | 0.42s | |
| ✅ DOCKERFILE | hadolint | 3 | 0 | 0 | 0.6s | |
| ✅ GHERKIN | gherkin-lint | 6 | 0 | 0 | 2.09s | |
| ✅ JSON | npm-package-json-lint | yes | no | no | 0.32s | |
| ✅ JSON | prettier | 21 | 4 | 0 | 0 | 0.48s |
| ✅ JSON | v8r | 21 | 0 | 0 | 6.73s | |
| markdownlint | 12 | 0 | 2 | 0 | 0.82s | |
| ✅ MARKDOWN | markdown-table-formatter | 12 | 0 | 0 | 0 | 0.2s |
| ✅ REPOSITORY | checkov | yes | no | no | 15.04s | |
| ✅ REPOSITORY | gitleaks | yes | no | no | 0.45s | |
| ✅ REPOSITORY | git_diff | yes | no | no | 0.01s | |
| ✅ REPOSITORY | grype | yes | no | no | 34.68s | |
| ✅ REPOSITORY | secretlint | yes | no | no | 0.78s | |
| ✅ REPOSITORY | syft | yes | no | no | 1.72s | |
| ✅ REPOSITORY | trivy | yes | no | no | 7.05s | |
| ✅ REPOSITORY | trivy-sbom | yes | no | no | 0.21s | |
| ✅ REPOSITORY | trufflehog | yes | no | no | 2.29s | |
| lychee | 81 | 4 | 0 | 11.69s | ||
| ✅ YAML | prettier | 29 | 0 | 0 | 0 | 0.84s |
| ✅ YAML | v8r | 29 | 0 | 0 | 6.97s | |
| ✅ YAML | yamllint | 29 | 0 | 0 | 0.63s |
Detailed Issues
⚠️ SPELL / lychee - 4 errors
[IGNORED] docker://pandoc/extra:3.7.0@sha256:a703d335fa237f8fc3303329d87e2555dca5187930da38bfa9010fa4e690933a | Unsupported: Error creating request client: builder error for url (docker://pandoc/extra:3.7.0@sha256:a703d335fa237f8fc3303329d87e2555dca5187930da38bfa9010fa4e690933a)
[ERROR] https://www.conventionalcommits.org/en/v1.0.0/ | Network error: error sending request for url (https://www.conventionalcommits.org/en/v1.0.0/) Maybe a certificate error?
[ERROR] https://www.contributor-covenant.org/version/2/0/code_of_conduct.html | Network error: error sending request for url (https://www.contributor-covenant.org/version/2/0/code_of_conduct.html) Maybe a certificate error?
[403] https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads | Network error: Forbidden
[IGNORED] https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/philips-software/amp-devcontainer | Unsupported: Error creating request client: builder error for url (vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/philips-software/amp-devcontainer)
[404] https://github.com/user-attachments/assets/bd514b53-60de-4206-b97d-be4971d4908f | Network error: Not Found
📝 Summary
---------------------
🔍 Total..........129
✅ Successful.....123
⏳ Timeouts.........0
🔀 Redirected.......0
👻 Excluded.........0
❓ Unknown..........0
🚫 Errors...........4
Errors in README.md
[404] https://github.com/user-attachments/assets/bd514b53-60de-4206-b97d-be4971d4908f | Network error: Not Found
Errors in .github/CONTRIBUTING.md
[ERROR] https://www.conventionalcommits.org/en/v1.0.0/ | Network error: error sending request for url (https://www.conventionalcommits.org/en/v1.0.0/) Maybe a certificate error?
Errors in .github/TOOL_VERSION_ISSUE_TEMPLATE.md
[403] https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads | Network error: Forbidden
Errors in .github/CODE_OF_CONDUCT.md
[ERROR] https://www.contributor-covenant.org/version/2/0/code_of_conduct.html | Network error: error sending request for url (https://www.contributor-covenant.org/version/2/0/code_of_conduct.html) Maybe a certificate error?
⚠️ MARKDOWN / markdownlint - 2 errors
README.md:145:1 error MD033/no-inline-html Inline HTML [Element: details]
README.md:145:10 error MD033/no-inline-html Inline HTML [Element: summary]
See detailed reports in MegaLinter artifacts
Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)
- Documentation: Custom Flavors
- Command:
npx mega-linter-runner@9.3.0 --custom-flavor-setup --custom-flavor-linters ACTION_ACTIONLINT,DOCKERFILE_HADOLINT,GHERKIN_GHERKIN_LINT,JSON_V8R,JSON_PRETTIER,JSON_NPM_PACKAGE_JSON_LINT,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,REPOSITORY_CHECKOV,REPOSITORY_GIT_DIFF,REPOSITORY_GITLEAKS,REPOSITORY_GRYPE,REPOSITORY_SECRETLINT,REPOSITORY_SYFT,REPOSITORY_TRIVY,REPOSITORY_TRIVY_SBOM,REPOSITORY_TRUFFLEHOG,SPELL_LYCHEE,YAML_PRETTIER,YAML_YAMLLINT,YAML_V8R
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
|
| @@ -1,8 +1,22 @@ | |||
| # amp-devcontainer | |||
|
|
|||
| <!-- markdownlint-disable --> | |||
There was a problem hiding this comment.
The README disables all markdownlint rules for the entire header block. It’s usually better to disable only the specific rule(s) needed (commonly MD033 for inline HTML) to avoid hiding other formatting issues in that section. Consider changing this to a targeted disable (e.g., <!-- markdownlint-disable MD033 -->) and re-enabling afterward.
|
|
||
| <i>-- Amplify! your developer experience</i> | ||
| </div> | ||
| <!-- markdownlint-enable --> |
There was a problem hiding this comment.
The README disables all markdownlint rules for the entire header block. It’s usually better to disable only the specific rule(s) needed (commonly MD033 for inline HTML) to avoid hiding other formatting issues in that section. Consider changing this to a targeted disable (e.g., <!-- markdownlint-disable MD033 -->) and re-enabling afterward.
| [](https://github.com/philips-software/amp-devcontainer/actions/workflows/linting-formatting.yml) [](https://github.com/philips-software/amp-devcontainer/actions/workflows/continuous-integration.yml) [](https://www.bestpractices.dev/projects/9267) [](https://securityscorecards.dev/viewer/?uri=github.com/philips-software/amp-devcontainer) | ||
| <!-- markdownlint enable --> | ||
|
|
||
| <i>-- Amplify! your developer experience</i> |
There was a problem hiding this comment.
Using <i> for emphasis is more “presentational” than semantic. Prefer <em> (or plain Markdown emphasis) for better accessibility/semantics, and consider dropping the leading -- if it’s only decorative (screen readers will read it literally).
| <a href="https://github.com/philips-software/amp-devcontainer"> | ||
| <div align="center"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/bd514b53-60de-4206-b97d-be4971d4908f"> |
There was a problem hiding this comment.
is this supposed to be visible in the readme view? on inspect I can see the code but I don't see the expect image
There was a problem hiding this comment.
While checking it out from my GitHub app I also don't see the image. I wonder if it is scoped to my user account, I was trying to refrain from adding the images to the repository. But I don't know if that will hold.
3 participants
🚀 Hey, I have created a Pull Request
Description of changes
This pull request updates the
README.mdto improve its visual presentation and branding. The most important change is the addition of a header section featuring a logo image and link to the repository.Documentation and branding improvements:
README.md, enhancing the project's branding and visual appeal.✔️ Checklist