Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add icons to docs #499

Merged
merged 8 commits into from
Nov 8, 2022
Merged

Conversation

lrjball
Copy link
Contributor

@lrjball lrjball commented Mar 29, 2021

Thought it could be useful to have an image showing what the icon looks like in the docs. Also fixes #466

This is how the change looks:

diagrams_docs_with_icons

I couldn't decide how to handle the white icons from OCI, so they are currently not visible against the white background, but they all have a black icon alternative next to them which is visible so that shouldn't be much of an issue. Can update this though if there any any suggestions for handling the white icons.

@gabriel-tessier
Copy link
Collaborator

Hi,

just for information there's already an issue about, you can check here: #78

The issue is pretty old but maybe there's some work in progress.

@lrjball
Copy link
Contributor Author

lrjball commented Apr 5, 2021

thanks @gabriel-tessier, I must have missed that issue when I checked. @mingrammer, is this issue being worked on or could this PR help? Don't mind either way, but happy to make changes to this one if needed

@mdavis-xyz
Copy link

@mingrammer said they'd do work on #78 , but that was over a year ago.

Given that there are so many duplicate issues raised for this, I believe it's a super valuable contribution. If it works, then we should just merge it.

@lrjball
Copy link
Contributor Author

lrjball commented Aug 4, 2021

@mingrammer, does this PR look okay? There are now a couple of merge conflicts which I resolve if this can go in. This seems like a fairly frequently requested feature

@mingrammer
Copy link
Owner

This is an AMAZING contribution. I love it ❤️ @lrjball Please resolve the conflicts, then I'll merge and deploy it.

@mingrammer mingrammer added kind/docs Improvements or additions to documentation status/accepted Accepted proposal labels Nov 4, 2022
@lrjball
Copy link
Contributor Author

lrjball commented Nov 6, 2022

@mingrammer thanks 😃 all conflicts are resolved now, just had to rerun the autogen.sh as new icons had been added since I first made this

@mingrammer
Copy link
Owner

There are many PRs that could be merged at any time. And I merged a PR, there was a conflict with this PR. I request the last update to resolve the conflict 🙏 Thank you!

@lrjball
Copy link
Contributor Author

lrjball commented Nov 7, 2022

Okay no worries, should be resolved now

@mingrammer mingrammer merged commit 23f8e76 into mingrammer:master Nov 8, 2022
@bdsoha
Copy link
Contributor

bdsoha commented Nov 8, 2022

@mingrammer This closes #78, #624, and #634

@mingrammer
Copy link
Owner

@lrjball I published the website :) Thank you so much.

@mingrammer
Copy link
Owner

@bdsoha I'll close those. Thank you for addressing it.

@bdsoha
Copy link
Contributor

bdsoha commented Nov 8, 2022

@mingrammer Sorry for the oversight, also #509.

@mingrammer
Copy link
Owner

mingrammer commented Nov 8, 2022

@bdsoha Thank you!! :D. I closed that.

@mingrammer
Copy link
Owner

I announced this feature: #777.

ngruelaneo pushed a commit to aneoconsulting/diagrams that referenced this pull request Nov 25, 2022
* Updated docs to include images of nodes

* Updated docs to include images of nodes

* Added icons to docs

* Added black formatting

* Added back png that removed due to incorrect naming convention

* Revert yarn.lock changes
ajmaradiaga pushed a commit to ajmaradiaga/diagrams that referenced this pull request Nov 8, 2023
* Updated docs to include images of nodes

* Updated docs to include images of nodes

* Added icons to docs

* Added black formatting

* Added back png that removed due to incorrect naming convention

* Revert yarn.lock changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs Improvements or additions to documentation status/accepted Accepted proposal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Please add a demo/example of each Node shape in documentation set
5 participants