Skip to content

docs: show the Trendshift daily-Kotlin award on the README and landing hero - #285

Merged
jeiel85 merged 2 commits into
mainfrom
claude/readme-trendshift-badge-ca5dd8
Jul 27, 2026
Merged

docs: show the Trendshift daily-Kotlin award on the README and landing hero#285
jeiel85 merged 2 commits into
mainfrom
claude/readme-trendshift-badge-ca5dd8

Conversation

@jeiel85

@jeiel85 jeiel85 commented Jul 27, 2026

Copy link
Copy Markdown
Owner

Markleaf reached #1 Kotlin repository of the day on Trendshift (23 Jul 2026). This puts the badge on both public surfaces, in all six languages.

What changed

  • READMEs (6) — badge block between the tagline and the shields row, since a 250×55 badge next to 20px shields reads badly.
  • Landing pages (6)a.hero-award in the hero copy block, directly under the release line.
  • landing.css — one 3-line rule (display: inline-block + top margin). The global img rule already handles max-width: 100%.
  • docs/assets/trendshift-daily-kotlin.svg — new, 3.7 KB, self-contained (no external refs, no scripts, internal gradient ids only).
  • docs/assets/README.md — records why the file is checked in and how to refresh it.

Why the two surfaces embed it differently

The READMEs use Trendshift's live badge URL. GitHub proxies README images through camo, so a reader never contacts Trendshift, and the badge stays accurate on its own.

GitHub Pages proxies nothing. Embedding the live URL there would have every visitor's browser hit a third party — on the page whose whole argument is that Markleaf does not phone home. So the landing pages serve a checked-in copy instead. The cost is that it no longer follows the live badge, which is fine: it records a dated achievement, not a current standing.

Deviations from the snippet Trendshift hands out: target="_blank" rel="noopener noreferrer" dropped (GitHub strips both and substitutes rel="nofollow"; no other external link in these files carries them), and the URL-encoded alt replaced with translated text, matching how the demo clips are already handled.

Verification

Check Result
scripts/check-landing-overflow.mjs OK — 12 pages × 6 widths, no horizontal overflow
scripts/verify-landing-versions.ps1 OK — all public-surface version checks pass (v2.32.1)
Headless render, 6 landing pages @ 320px and 1280px SVG loads (natural 250×55), renders 250×55, 24px below the release line, inside the viewport and the hero block, alt non-empty on every page
gh api -X POST markdown on the README header Link (utm params intact), width/height and alt all survive sanitisation; image resolves through camo
Badge source 200 image/svg+xml, SVG text reads #1 Repository Of The Day · TRENDSHIFT

Docs only — no app code touched.

🤖 Generated with Claude Code

…g hero

Markleaf reached #1 Kotlin repository of the day on Trendshift (23 Jul 2026).
The badge goes on both public surfaces, in all six languages, with the alt text
translated the way the demo clips already are.

The two surfaces embed it differently on purpose. The READMEs use Trendshift's
live badge URL: GitHub proxies README images through camo, so a reader never
contacts Trendshift and the badge stays accurate on its own. GitHub Pages
proxies nothing, so the landing pages serve a checked-in copy of the SVG
instead — embedding the live URL there would have every visitor's browser hit a
third party, on the page whose whole argument is that Markleaf does not phone
home. docs/assets/README.md records that trade-off and how to refresh the file.

Verified: check-landing-overflow.mjs passes (12 pages x 6 widths, no horizontal
overflow) and verify-landing-versions.ps1 still passes; a headless render
confirms the SVG loads and sits inside the hero on all six pages at 320px and
1280px; GitHub's markdown API confirms the README embed survives sanitisation
with its link, dimensions and alt intact.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d66cfc671d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/index.html
Comment on lines +95 to +96
<a class="hero-award" href="https://trendshift.io/repositories/58116?utm_source=trendshift-badge&amp;utm_medium=badge&amp;utm_campaign=badge-trendshift-58116">
<img src="assets/trendshift-daily-kotlin.svg" width="250" height="55" alt="Markleaf — #1 Kotlin repository of the day on Trendshift">

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Record the user-facing documentation change

This adds the award to the public README and landing surfaces, but the commit updates neither CHANGELOG.md nor HISTORY.md. The repository requires user-impacting changes to be recorded in the changelog and every work unit to be logged in project history, so add the corresponding entries before merging.

AGENTS.md reference: AGENTS.md:L219-L223

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Half of this is right, and it is fixed in 1367b22.

HISTORY.md — agreed. AGENTS.md:222 asks for a work-unit entry, and PR #282 (a docs-only landing and README change) set the precedent by logging one. Added.

CHANGELOG.md — not applicable here. CHANGELOG.md is strictly version-sectioned (## vX.Y.Z - Title - YYYY-MM-DD) and is the literal source the release job's awk parser cuts GitHub release notes from — AGENTS.md:229-231 makes that dependency explicit, and the job fails on test -s release-title.txt if the shape breaks. There is no Unreleased section, and this PR carries no version bump, so recording it would mean either inventing a version section or editing v2.32.1's already-tagged and already-published release notes. Nothing about the app changed either: the badge is on the README and the landing hero, and an APK built before and after this commit is identical.

AGENTS.md:219 also scopes that list to 코드 변경 시 — when code changes. PR #282 is the nearest analogue and updated HISTORY without touching CHANGELOG, which is the same call.

The reasoning is recorded in the HISTORY entry so the question does not have to be re-litigated next time.

Codex review flagged the missing documentation record. AGENTS.md keeps a
work-unit entry in HISTORY.md for every change, and PR #282 — a docs-only
landing and README change — set the precedent.

The same review also asked for a CHANGELOG entry. That half does not apply:
CHANGELOG.md is strictly version-sectioned and is the source the release job's
awk parser cuts GitHub release notes from, it has no Unreleased section, and
this change carries no version bump, so an entry would mean inventing a version
or editing v2.32.1's already-published notes. Nothing about the app changed.
The HISTORY entry records that reasoning.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@jeiel85
jeiel85 merged commit 08ff27f into main Jul 27, 2026
6 checks passed
@jeiel85
jeiel85 deleted the claude/readme-trendshift-badge-ca5dd8 branch July 27, 2026 02:12
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