Skip to content

bring the README header in line with the awesome guidelines - #34

Merged
kanywst merged 2 commits into
mainfrom
audit-readme-header-guidelines
Sep 4, 2026
Merged

kanywst merged 2 commits into
mainfrom
audit-readme-header-guidelines

Conversation

@kanywst

@kanywst kanywst commented Sep 4, 2026

Copy link
Copy Markdown
Owner

What does this PR add?

Three header issues that awesome-lint does not check but the submission guidelines do. All three are in the first eight lines.

1. The description described the list, not the topic.

- > Authorization and access control: policy engines, standards, services, and learning resources.
+ > Determining what an authenticated user or service is permitted to do.

The old line read out the table of contents without ever saying what authorization is. That is the shape the guidelines reject (❌ Resources and tools for iOS development. vs ✅ Mobile operating system for Apple phones and tablets.), and it is what got #1042 and #2607 sent back.

2. The heading and the logo both said "Awesome Authorization".

Don't include both a title saying Awesome X and a logo with Awesome X.

media/logo.svg carried the wordmark in two <text> elements. Those are gone; the shield mark remains and the Markdown heading is now the only place the name appears. The viewBox is cropped to the mark and given explicit dimensions since the width can no longer be set from the img tag.

3. The logo linked nowhere.

The image should link to the project website or any relevant website.

It now links back to the repo. Switching from a raw <img> to a Markdown image-link also means no new MD033 inline-HTML violations — the count stays at the one pre-existing <div align="center">.

Checks

  • markdownlint-cli2: 1 issue, the pre-existing <div>. No regression.
  • awesome-lint on the file: no content errors; heading and badge rules still satisfied.

@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 45 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: c395f05f-d93c-493a-b4ca-b4d89a247272

📥 Commits

Reviewing files that changed from the base of the PR and between ed9bf1c and 03cc9df.

⛔ Files ignored due to path filters (1)
  • media/logo.svg is excluded by !**/*.svg
📒 Files selected for processing (1)
  • README.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@claude

claude Bot commented Sep 4, 2026

Copy link
Copy Markdown

Reviewed against the curation/description/category/duplicate/header checklist: this diff only touches the README header (description line) and media/logo.svg, no list entries changed, so items 1–4 don't apply here. The three header fixes hold up: the blockquote now describes the topic itself (README.md:9) rather than restating the Contents section, the logo's wordmark <text> elements are gone so "Awesome Authorization" only appears once (the heading), and the logo is now a Markdown image-link to the repo (README.md:5) instead of a bare <img>, so no new MD033 hits are introduced. Contents section (README.md:13-21) is untouched and still matches the headings below it. Clean — no findings.

@kanywst
kanywst merged commit 5d7c6e9 into main Sep 4, 2026
3 checks passed
@kanywst
kanywst deleted the audit-readme-header-guidelines branch September 4, 2026 12:04
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.

1 participant