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

Remove "Platforms: macOS" supported platforms banner #271

Merged
merged 3 commits into from
May 31, 2024

Conversation

calda
Copy link
Member

@calda calda commented May 30, 2024

We realized that the "Platforms: macOS" banner at the top of the README is potentially confusing.

These Swift Package Index banners refer to the Swift versions and platforms supported by our Swift package plugin. However, without this context it may look like this is saying that the Style Guide primarily supports macOS.

I still like the Swift versions banner, so think that's worth keeping. This has the side effect of suggesting that the style guide itself "supports" the given range of Swift versions, which is true.

Before

image

After

image

@airbnb/swift-styleguide-maintainers

Copy link
Contributor

@bachand bachand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that we should remove this banner for clarity given its current placement.

I wonder if there is a way to clarify that the Swift version banner refers to the Swift package plugin?

Instead of removing this platforms banner, we could move both banners from the top of the README to a section, or a standalone markdown file, about the package plugin 🤔

@calda
Copy link
Member Author

calda commented May 31, 2024

This is what it looks like if we move the badges to the package plugin subsection:

image

I think this would be reasonable, but personally I prefer the look of having the supported version badge at the top of the page. After having the badge at the top for a while, the page without the badge at the top feels like it's missing something. I also like that it's a piece of dynamic content suggesting "yes, the style guide is 'up to date' for the latest version of Swift".

@calda calda merged commit 8b2776f into master May 31, 2024
5 checks passed
@calda calda deleted the cal--remove-platform-banner branch May 31, 2024 15:20
@bachand
Copy link
Contributor

bachand commented Jun 1, 2024

Thanks for trying out the alternative idea, @calda . Keeping the Swift versions banner at the top and removing the platforms banner sounds good to me! I see what you are saying about it feeling like something is missing without the Swift versions banner at the top of the README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants