Skip to content

docs: fix stale badge/docs links in README - #48

Merged
halotukozak merged 1 commit into
mainfrom
update-readme
Sep 1, 2026
Merged

docs: fix stale badge/docs links in README#48
halotukozak merged 1 commit into
mainfrom
update-readme

Conversation

@halotukozak

Copy link
Copy Markdown
Collaborator

Summary

Audited README.md against the current state of the repo (build files, source, Maven Central, GitHub Pages config). Found the three header badges still pointing at the old halotukozak GitHub owner from before the org move to halotukozak-com:

  • Docs badge linked to https://halotukozak.github.io/sure/, which redirects to the unrelated personal site halotukozak.com (its 404 page) — not the project docs. The real Dokka docs are served at https://sure.halotukozak.com/ (confirmed via the repo's GitHub Pages API config: custom domain sure.halotukozak.com).
  • CI and codecov badges pointed at github.com/halotukozak/sure / codecov.io/gh/halotukozak/sure. These still 200/301-redirect to the right place today, but no longer match the canonical halotukozak-com/sure repo location.

Everything else checked out as accurate and was left untouched:

  • Kotlin 2.4.10, KMP targets (jvm, iosX64, iosArm64, iosSimulatorArm64) match sure/build.gradle.kts.
  • The field/notBlank/lengthIn/.validate() example matches the current DSL in Checks.kt / Validator.kt / the KSP-generated extensions.
  • The io.github.halotukozak:sure:0.1.0 / sure-ksp:0.1.0 coordinates match the latest (and only) release on Maven Central and the v0.1.0 git tag.

Test plan

  • Verified https://sure.halotukozak.com/ returns 200 and is the Dokka docs site (from repo's Pages config).
  • Verified https://halotukozak.github.io/sure/ redirects to halotukozak.com/404, confirming the old badge was broken/misleading.
  • Verified new CI/codecov badge URLs resolve (200) under halotukozak-com/sure.
  • Render the README on GitHub to confirm badges display correctly.

The org moved from halotukozak to halotukozak-com (repo now lives at
github.com/halotukozak-com/sure), but the README badges still pointed
at the old owner:

- The docs badge linked to https://halotukozak.github.io/sure/, which
  redirects to the unrelated personal site halotukozak.com (its 404
  page), not the project's Dokka docs. The real docs are published at
  https://sure.halotukozak.com/ (per the repo's GitHub Pages config).
- The CI and codecov badges pointed at github.com/halotukozak/sure and
  codecov.io/gh/halotukozak/sure, which still resolve via redirect but
  no longer match the canonical halotukozak-com/sure location.

Verified against current repo state: Kotlin 2.4.10 / KMP targets
(jvm, iosX64, iosArm64, iosSimulatorArm64) / DSL API / 0.1.0 Maven
Central release referenced in the README are all accurate, so no
other changes were needed.
Copilot AI lite review requested due to automatic review settings September 1, 2026 19:33

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@halotukozak
halotukozak merged commit 01fdedc into main Sep 1, 2026
1 check passed
@halotukozak
halotukozak deleted the update-readme branch September 1, 2026 19:50
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