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

docs: Add the ability to deprecate icons #1150

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

korki43
Copy link
Contributor

@korki43 korki43 commented Dec 18, 2021

Icons can be deprecated by giving them the deprecated tag. They won't show up in search results and have a deprecation notice on their page. This is inspired by #843.

When the first icon is deprecated someone would need to recompile bootstrap.min.css because this adds an alert-danger component.

This is just a proposed solution and will definitely need some discussion.

@mdo
Copy link
Member

mdo commented Jul 13, 2022

I'd probably suggest a deprecated: true key instead of using a tag. Thoughts?

@mdo mdo added docs Improvements or additions to documentation enhancement New feature or request labels Jul 13, 2022
@twbs twbs deleted a comment from korki43 Mar 25, 2023
@korki43
Copy link
Contributor Author

korki43 commented Mar 26, 2023

Changed it to a deprecated: true tag. I also added an example to preview the deprecation notice alert:

https://deploy-preview-1150--bootstrap-icons.netlify.app/icons/~deprecated/

@XhmikosR XhmikosR changed the title Add ability to deprecate icons docs: Add the ability to deprecate icons Mar 26, 2023
@korki43 korki43 marked this pull request as ready for review March 26, 2023 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants