docs: add used by section#293
Conversation
shenxianpeng
force-pushed
the
add-used-by-section
branch
from
8cabbc7 to
f1eaf07
Compare
shenxianpeng
force-pushed
the
add-used-by-section
branch
from
f1eaf07 to
4103d59
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.md (2)
68-69: New "Used By" Section Header Added
The new header clearly introduces the "Used By" section. Consider adding a short introductory sentence or description before the logos to provide context about this section to readers.
70-94: Logo Showcase and Accessibility Check
The section displays the logos of prominent organizations nicely using HTML. The use ofaltattributes on the images is good for accessibility. Additionally, using a<p align="center">container helps maintain a centered layout. Optionally, you might explore adding CSS classes or inline styles to enhance spacing or responsiveness across devices.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/workflows/used-by.yml(0 hunks)README.md(1 hunks)
💤 Files with no reviewable changes (1)
- .github/workflows/used-by.yml
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
Any objection to using a table? [Microsoft]: https://avatars.githubusercontent.com/u/6154722?s=50&v=4
[Microsoft-home]: https://github.com/Microsoft
[Apache]: https://avatars.githubusercontent.com/u/47359?s=50&v=4
[Apache-home]: https://github.com/apache
[NASA]: https://avatars.githubusercontent.com/u/848102?s=50&v=4
[NASA-home]: https://github.com/nasa
[Samsung]: https://avatars.githubusercontent.com/u/6210390?s=50&v=4
[Samsung-home]: https://github.com/samsung
[The Algorithms]: https://avatars.githubusercontent.com/u/20487725?s=50&v=4
[The Algorithms-home]: https://github.com/TheAlgorithms
[CachyOS]: https://avatars.githubusercontent.com/u/85452089?s=50&v=4
[CachyOS-home]: https://github.com/CachyOS
[Nextcloud]: https://avatars.githubusercontent.com/u/19211038?s=50&v=4
[Nextcloud-home]: https://github.com/nextcloud
[Jupyter]: https://avatars.githubusercontent.com/u/58793052?s=50&v=4
[Jupyter-home]: https://github.com/jupyter-xeus
[NNStreamer]: https://avatars.githubusercontent.com/u/60992508?s=50&v=4
[NNStreamer-home]: https://github.com/nnstreamer
[imgproxy]: https://avatars.githubusercontent.com/u/48099924?s=50&v=4
[imgproxy-home]: https://github.com/imgproxy
[Zondax]: https://avatars.githubusercontent.com/u/34372050?s=50&v=4
[Zondax-home]: https://github.com/Zondax
[AppNeta]: https://avatars.githubusercontent.com/u/3374594?s=50&v=4
[AppNeta-home]: https://github.com/AppNeta
[Chocolate Doom]: https://avatars.githubusercontent.com/u/6140118?s=50&v=4
[Chocolate Doom-home]: https://github.com/chocolate-doom
||||||||
|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
| [![Microsoft]<br>Microsoft][Microsoft-home] | [![Apache]<br>Apache][Apache-home] | [![NASA]<br>NASA][NASA-home] | [![Samsung]<br>Samsung][Samsung-home] | [![The Algorithms]<br>The Algorithms][The Algorithms-home] | [![CachyOS]<br>CachyOS][CachyOS-home] | [![Nextcloud]<br>Nextcloud][Nextcloud-home] |
| [![Jupyter]<br>Jupyter][Jupyter-home] | [![NNStreamer]<br>NNStreamer][NNStreamer-home] | [![imgproxy]<br>imgproxy][imgproxy-home] | [![Zondax]<br>Zondax][Zondax-home] | [![AppNeta]<br>AppNeta][AppNeta-home] | [![Chocolate Doom]<br>Chocolate Doom][Chocolate Doom-home] | [and many more](https://github.com/cpp-linter/cpp-linter-action/network/dependents) |would render as
|
|
showing in table is not bad, just the icon for now looks too big. the current changes was got insight from https://autofix.ci/ |
|
I think the size can be adjusted in the links' |
|
took another look, I might more prefer the style from https://autofix.ci/ if comparing table : ) |
|
They are able align the logo with the brand name using CSS (see autofix.ci doc source). We can't use raw CSS in Github Flavored markdown. I've seen the table tactic used in READMEs on github to mention contributors (similar to "Used by" mentions). Also, markdown linters discourage the use of raw HTML in markdown syntax. Its rather error prone (and unsafe depending on complexity). |
|
I updated my comment. Each table cell now links to the github org/user page, and the images are smaller. |
I completely agree with your comments.
Just compared with the table, this would perhaps look better https://github.com/shenxianpeng/gitstats/tree/main?tab=readme-ov-file#contributors. |
|
Can we drop using the table but also have the same result as below using Markdown, not HTML.
|
shenxianpeng
force-pushed
the
add-used-by-section
branch
from
559c206 to
604bf1a
Compare
|
That image of contributors is generated by contrib.rocks. It would be nice to find something that would similarly generated a "Used By" image. |
|
Without the table syntax: [Microsoft]: https://avatars.githubusercontent.com/u/6154722?s=20&v=4
[Microsoft-home]: https://github.com/Microsoft
[Apache]: https://avatars.githubusercontent.com/u/47359?s=20&v=4
[Apache-home]: https://github.com/apache
[NASA]: https://avatars.githubusercontent.com/u/848102?s=20&v=4
[NASA-home]: https://github.com/nasa
[Samsung]: https://avatars.githubusercontent.com/u/6210390?s=20&v=4
[Samsung-home]: https://github.com/samsung
[The Algorithms]: https://avatars.githubusercontent.com/u/20487725?s=20&v=4
[The Algorithms-home]: https://github.com/TheAlgorithms
[CachyOS]: https://avatars.githubusercontent.com/u/85452089?s=20&v=4
[CachyOS-home]: https://github.com/CachyOS
[Nextcloud]: https://avatars.githubusercontent.com/u/19211038?s=20&v=4
[Nextcloud-home]: https://github.com/nextcloud
[Jupyter]: https://avatars.githubusercontent.com/u/58793052?s=20&v=4
[Jupyter-home]: https://github.com/jupyter-xeus
[NNStreamer]: https://avatars.githubusercontent.com/u/60992508?s=20&v=4
[NNStreamer-home]: https://github.com/nnstreamer
[imgproxy]: https://avatars.githubusercontent.com/u/48099924?s=20&v=4
[imgproxy-home]: https://github.com/imgproxy
[Zondax]: https://avatars.githubusercontent.com/u/34372050?s=20&v=4
[Zondax-home]: https://github.com/Zondax
[AppNeta]: https://avatars.githubusercontent.com/u/3374594?s=20&v=4
[AppNeta-home]: https://github.com/AppNeta
[Chocolate Doom]: https://avatars.githubusercontent.com/u/6140118?s=20&v=4
[Chocolate Doom-home]: https://github.com/chocolate-doom
[![Microsoft]Microsoft][Microsoft-home] [![Apache]Apache][Apache-home] [![NASA]NASA][NASA-home] [![Samsung]Samsung][Samsung-home] [![The Algorithms]The Algorithms][The Algorithms-home] [![CachyOS]CachyOS][CachyOS-home] [![Nextcloud]Nextcloud][Nextcloud-home]
[![Jupyter]Jupyter][Jupyter-home] [![NNStreamer]NNStreamer][NNStreamer-home] [![imgproxy]imgproxy][imgproxy-home] [![Zondax]Zondax][Zondax-home] [![AppNeta]AppNeta][AppNeta-home] [![Chocolate Doom]Chocolate Doom][Chocolate Doom-home]
[and many more](https://github.com/cpp-linter/cpp-linter-action/network/dependents)Would renders as
|
Microsoft
Apache
NASA
Samsung
The Algorithms
CachyOS
Nextcloud
Jupyter
NNStreamer
imgproxy
Zondax
AppNeta
Chocolate Doom
|
Some of these logos are unrecognizable at such a small size. I thought the whole point is to mention recognizable brands that use our product. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
18-44: Logo URL Definitions: Verify the Chosen Image Size Parameter
The referenced logo images use the query parameters=20, which sets the image size to 20 pixels. Given the earlier discussion where reducing from very large sizes (e.g., 200) was suggested to something around 85 pixels, please confirm that 20 pixels meets your design intent. Logos at 20px may appear too small for clear visibility.
95-100: "Used By" Section Layout: Check Visual Alignment and Readability
The new "Used By" section is implemented as an inline sequence of markdown links rather than a table format. While this streamlines the presentation, it would be worthwhile to test how the layout renders across different devices and screen sizes to ensure that both the logos and their accompanying text are well-aligned and readable.🧰 Tools
🪛 LanguageTool
[style] ~99-~99: Using many exclamation marks might seem excessive (in this case: 15 exclamation marks for a text that’s 2998 characters long)
Context: ...ome] [![Jupyter]Jupyter][Jupyter-home] [![NNStreamer]NNStreamer][NNStreamer-home] [![imgproxy]imgproxy][imgproxy-home] [![Zondax]Zondax][Zondax-home] [![AppNeta]AppNeta][AppNeta-home] [![Chocolate Doom]Chocolate Doom][Chocolat...(EN_EXCESSIVE_EXCLAMATION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~99-~99: Using many exclamation marks might seem excessive (in this case: 15 exclamation marks for a text that’s 2998 characters long)
Context: ...ome] [![Jupyter]Jupyter][Jupyter-home] [![NNStreamer]NNStreamer][NNStreamer-home] [![imgproxy]imgproxy][imgproxy-home] [![Zondax]Zondax][Zondax-home] [![AppNeta]AppNeta][AppNeta-home] [![Chocolate Doom]Chocolate Doom][Chocolat...
(EN_EXCESSIVE_EXCLAMATION)
This comment was marked as resolved.
This comment was marked as resolved.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
68-77: New "Used By" Section Addition and Reference Definitions
The newly added "Used By" section is clearly structured and the reference definitions for each organization’s logo and home URL are correctly provided.Consider enhancing accessibility by using more descriptive alt text for images—for example, using "Microsoft Logo" instead of just "Microsoft"—to improve sematic clarity in Markdown.
78-95: Logo Image Size Consistency Check
The image URLs include the size parameters=25, which ensures small icons. Verify that this size aligns with your intended design; earlier discussions mentioned potentially usings=85to balance readability and visual appeal.If the current size appears too small or inconsistent with other graphical elements, consider adjusting the size parameter accordingly.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~99-~99: Using many exclamation marks might seem excessive (in this case: 15 exclamation marks for a text that’s 2998 characters long)
Context: ...ome] [![Jupyter]Jupyter][Jupyter-home] [![NNStreamer]NNStreamer][NNStreamer-home] [![imgproxy]imgproxy][imgproxy-home] [![Zondax]Zondax][Zondax-home] [![AppNeta]AppNeta][AppNeta-home] [![Chocolate Doom]Chocolate Doom][Chocolat...
(EN_EXCESSIVE_EXCLAMATION)
🔇 Additional comments (1)
README.md (1)
97-100: Inline Organization Links Presentation
The inline assembly of organization logos using reference style links appears to render correctly in Markdown. Please double-check that the spacing and alignment meet the design expectations, especially in light of earlier comments regarding visual consistency.🧰 Tools
🪛 LanguageTool
[style] ~99-~99: Using many exclamation marks might seem excessive (in this case: 15 exclamation marks for a text that’s 2998 characters long)
Context: ...ome] [![Jupyter]Jupyter][Jupyter-home] [![NNStreamer]NNStreamer][NNStreamer-home] [![imgproxy]imgproxy][imgproxy-home] [![Zondax]Zondax][Zondax-home] [![AppNeta]AppNeta][AppNeta-home] [![Chocolate Doom]Chocolate Doom][Chocolat...(EN_EXCESSIVE_EXCLAMATION)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
68-96: "Used By" Section – Reference Definitions and Image Size Consistency
The new "Used By" section is clearly delineated with properly defined reference links for each organization. However, please verify that the image size parameters (s=28) render as intended across different devices and platforms. This size is considerably smaller than the previously discussed value (e.g.,s=85), so ensure that the visual impact matches your design goals.
97-100: Logo Layout and Spacing Consideration
The inline concatenation of logos and their corresponding names is concise, but it may lead to alignment or wrapping issues on smaller screens. If the logos are not aligning as expected, consider inserting manual line breaks or additional spacing to better control the layout within GitHub Flavored Markdown.🧰 Tools
🪛 LanguageTool
[style] ~99-~99: Using many exclamation marks might seem excessive (in this case: 15 exclamation marks for a text that’s 2998 characters long)
Context: ...ome] [![Jupyter]Jupyter][Jupyter-home] [![NNStreamer]NNStreamer][NNStreamer-home] [![imgproxy]imgproxy][imgproxy-home] [![Zondax]Zondax][Zondax-home] [![AppNeta]AppNeta][AppNeta-home] [![Chocolate Doom]Chocolate Doom][Chocolat...(EN_EXCESSIVE_EXCLAMATION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~99-~99: Using many exclamation marks might seem excessive (in this case: 15 exclamation marks for a text that’s 2998 characters long)
Context: ...ome] [![Jupyter]Jupyter][Jupyter-home] [![NNStreamer]NNStreamer][NNStreamer-home] [![imgproxy]imgproxy][imgproxy-home] [![Zondax]Zondax][Zondax-home] [![AppNeta]AppNeta][AppNeta-home] [![Chocolate Doom]Chocolate Doom][Chocolat...
(EN_EXCESSIVE_EXCLAMATION)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
70-95: Reference Definitions and Avatar Size Parameter
All reference definitions for the user logos have been added correctly. One point to consider is the use of thes=28parameter in the avatar URLs. Previously, there was discussion about the icon size being too large and suggestions to use something likes=85for better clarity. Please verify thats=28meets your visual design requirements across different devices, or adjust if necessary.
97-99: Clickable Image Link Markdown Syntax Improvement
The current clickable logo syntax (e.g.,[![Microsoft]Microsoft][Microsoft-home]) might not render as intended. The standard Markdown syntax for an image wrapped in a link is:[![Alt text][reference]][link-reference]This means each logo entry should be reformatted. For example, change:
-[![Microsoft]Microsoft][Microsoft-home] +[![Microsoft][Microsoft]][Microsoft-home]Applying this consistently, here’s a suggested diff for the two lines:
-[![Microsoft]Microsoft][Microsoft-home] [![Apache]Apache][Apache-home] [![NASA]NASA][NASA-home] [![Samsung]Samsung][Samsung-home] [![The Algorithms]The Algorithms][The Algorithms-home] [![CachyOS]CachyOS][CachyOS-home] [![Nextcloud]Nextcloud][Nextcloud-home] [![Jupyter]Jupyter][Jupyter-home] +[![Microsoft][Microsoft]][Microsoft-home] [![Apache][Apache]][Apache-home] [![NASA][NASA]][NASA-home] [![Samsung][Samsung]][Samsung-home] [![The Algorithms][The Algorithms]][The Algorithms-home] [![CachyOS][CachyOS]][CachyOS-home] [![Nextcloud][Nextcloud]][Nextcloud-home] [![Jupyter][Jupyter]][Jupyter-home]-[![NNStreamer]NNStreamer][NNStreamer-home] [![imgproxy]imgproxy][imgproxy-home] [![Zondax]Zondax][Zondax-home] [![AppNeta]AppNeta][AppNeta-home] [![Chocolate Doom]Chocolate Doom][Chocolate Doom-home] [and many more](https://github.com/cpp-linter/cpp-linter-action/network/dependents) +[![NNStreamer][NNStreamer]][NNStreamer-home] [![imgproxy][imgproxy]][imgproxy-home] [![Zondax][Zondax]][Zondax-home] [![AppNeta][AppNeta]][AppNeta-home] [![Chocolate Doom][Chocolate Doom]][Chocolate Doom-home] [and many more](https://github.com/cpp-linter/cpp-linter-action/network/dependents)This change will ensure that the images display as clickable logos with correct alt text.
🧰 Tools
🪛 LanguageTool
[style] ~99-~99: Using many exclamation marks might seem excessive (in this case: 15 exclamation marks for a text that’s 2997 characters long)
Context: ...NNStreamer]NNStreamer][NNStreamer-home] [![imgproxy]imgproxy][imgproxy-home] [![Zondax]Zondax][Zondax-home] [![AppNeta]AppNeta][AppNeta-home] [![Chocolate Doom]Chocolate Doom][Chocolat...(EN_EXCESSIVE_EXCLAMATION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~99-~99: Using many exclamation marks might seem excessive (in this case: 15 exclamation marks for a text that’s 2997 characters long)
Context: ...NNStreamer]NNStreamer][NNStreamer-home] [![imgproxy]imgproxy][imgproxy-home] [![Zondax]Zondax][Zondax-home] [![AppNeta]AppNeta][AppNeta-home] [![Chocolate Doom]Chocolate Doom][Chocolat...
(EN_EXCESSIVE_EXCLAMATION)
🔇 Additional comments (1)
README.md (1)
68-68: New "Used By" Section Header Introduced
The addition of the "## Used By" header nicely segments this section from the rest of the documentation. Please ensure that the header level (H2) is consistent with the overall document structure.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
68-102: New "Used By" Section ImplementationThe new "Used By" section is a clear and valuable addition that showcases key organizations using the C/C++ Linter Action. The reference-style links and inline logo display provide a streamlined presentation compared to a table format.
A couple of points to consider:
- Image Size & Alignment: Although the URLs now use
s=28(resulting in relatively small icons), please verify in the GitHub Markdown preview that the logos appear balanced and properly aligned with the accompanying text. This was a concern in previous discussions.- Punctuation Consistency: A static analysis hint noted that a punctuation mark might be missing (around the logo references section, e.g. near line 101). Consider whether adding a period or adjusting spacing would improve consistency and readability.
Overall, the new section meets the documentation enhancement objectives.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~101-~101: A punctuation mark might be missing here.
Context: ...proxy][imgproxy-home] [![Zondax] Zondax][Zondax-home] [![AppNeta] AppNeta][AppNe...(AI_EN_LECTOR_MISSING_PUNCTUATION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~101-~101: A punctuation mark might be missing here.
Context: ...proxy][imgproxy-home] [![Zondax] Zondax][Zondax-home] [![AppNeta] AppNeta][AppNe...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
68-97: Verify "Used By" Section Link Definitions and Image Size
The new "Used By" section correctly defines all the reference links for the organizations' logos. Please confirm that the chosen avatar size parameter (s=28) matches your design intent, considering previous discussions recommended a smaller size than the original (e.g., adjusted froms=200to abouts=85). If a larger display is desired for better visibility, you might need to update these parameters accordingly.🧰 Tools
🪛 LanguageTool
[uncategorized] ~97-~97: A punctuation mark might be missing here.
Context: ...soft][Microsoft-home] [![Apache] Apache][Apache-home] [![NASA] NASA][NASA-home] ...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~97-~97: A punctuation mark might be missing here.
Context: ...e] Apache][Apache-home] [![NASA] NASA][NASA-home] [![Samsung] Samsung][Samsu...(AI_EN_LECTOR_MISSING_PUNCTUATION)
98-104: Optimize Inline Logos Layout for Consistency and Readability
The inline display of logos using for spacing achieves a compact layout; however, it may lead to alignment issues on different screen sizes or cause readability challenges. Additionally, static analysis hints suggested that a punctuation mark might be missing in areas around lines ~97 and ~102. Consider verifying the visual consistency across devices or, if needed, introducing subtle punctuation or additional line breaks to enhance the clarity of the layout.🧰 Tools
🪛 LanguageTool
[uncategorized] ~102-~102: A punctuation mark might be missing here.
Context: ...proxy][imgproxy-home] [![Zondax] Zondax][Zondax-home] [![AppNeta] AppNeta][AppNe...(AI_EN_LECTOR_MISSING_PUNCTUATION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~97-~97: A punctuation mark might be missing here.
Context: ...soft][Microsoft-home] [![Apache] Apache][Apache-home] [![NASA] NASA][NASA-home] ...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~97-~97: A punctuation mark might be missing here.
Context: ...e] Apache][Apache-home] [![NASA] NASA][NASA-home] [![Samsung] Samsung][Samsu...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~102-~102: A punctuation mark might be missing here.
Context: ...proxy][imgproxy-home] [![Zondax] Zondax][Zondax-home] [![AppNeta] AppNeta][AppNe...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
|
v1 v2 I'll proceed with V2 for the final version. Thanks for the feedback—I appreciate the input! |
|
I'd like it to show up on the home page as soon as possible, although this isn't the most perfect rendering either, so maybe the back will make it better. |
2 participants
Summary by CodeRabbit