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

chore(docs): refactor README.md #70503

Merged
merged 4 commits into from
Oct 2, 2024
Merged

Conversation

Marukome0743
Copy link
Contributor

Summary

Remove redundant html element and css.
Add alt text to images.
Both old and new README.md have the same appearance.

Description

I changed some parts.

1. Insert align="center" into only top <div> tag

The all of logo, title, and badges are center.
Then it doesn't need to call at every element.

2. Move <h1> tag outside <a> tag

The title doesn't have link even if inside <a> tag when it's wrapped heading element.
So put it out for the readability.

3. Use image alt text instead of aria-label

Alt text is displayed on the page if the images can't be loaded.
That's why I prefer alt text to aria-label.
In addition, the screen reader still reads the same words after updating.

Improving Documentation

x-ref: <img>: The Image Embed element | mdn web docs

@ijjk
Copy link
Member

ijjk commented Sep 26, 2024

Allow CI Workflow Run

  • approve CI run for commit: 2063149

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

Copy link
Member

@ijjk ijjk left a comment

Choose a reason for hiding this comment

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

It looks like this doesn't apply as expected.

CleanShot 2024-10-01 at 10 58 44@2x

@Marukome0743
Copy link
Contributor Author

Marukome0743 commented Oct 1, 2024

It looks like this doesn't apply as expected.

As you say, GitHub Display the rich diff shows left align items.
However, the output result is correctly center align because align="center" parse text-align: -webkit-center css.

I'm not sure why GitHub rich diff shows different preview.
But text-align: -webkit-center affects the every child elements.

Copy link
Member

@ijjk ijjk left a comment

Choose a reason for hiding this comment

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

Ah yea looks like a quirk of the diff view, seems fine in full view

@ijjk ijjk enabled auto-merge (squash) October 2, 2024 01:31
@ijjk ijjk disabled auto-merge October 2, 2024 01:40
@ijjk ijjk merged commit 1d1b846 into vercel:canary Oct 2, 2024
38 checks passed
@Marukome0743 Marukome0743 deleted the Marukome0743-patch-1 branch October 2, 2024 02:12
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants