Skip to content

fix(readme): update links to img2num.dev domain - #508

Merged
Ryan-Millard merged 1 commit into
devfrom
docs/py/readme-link-fix
Jul 9, 2026
Merged

fix(readme): update links to img2num.dev domain#508
Ryan-Millard merged 1 commit into
devfrom
docs/py/readme-link-fix

Conversation

@Ryan-Millard

Copy link
Copy Markdown
Owner

Changes & Reason

Changes

Just the links.

Reason

The old ones used ryan-millard.github.io, which is now old.

@github-actions github-actions Bot added the docs label Jul 9, 2026
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

❌ This PR targets main directly — please retarget it to dev

Direct merges into main are not permitted. Please update the base branch of this PR to dev.

Warning

This comment will reappear on every push until the base branch is changed.

We block direct merges to main to ensure the quality of production code.

@Ryan-Millard
Ryan-Millard changed the base branch from main to dev July 9, 2026 06:20
@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@Ryan-Millard, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 10 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: e63bd4fa-ae42-48ca-87cf-49cd011ffcd2

📥 Commits

Reviewing files that changed from the base of the PR and between 74b1505 and 5c83e44.

📒 Files selected for processing (1)
  • packages/py/README.md

Walkthrough

This PR updates hardcoded documentation, changelog, blog, and footer URLs in packages/py/README.md, replacing the old ryan-millard.github.io/Img2Num host with the new img2num.dev host across badges, links, and tables, along with a minor footer div adjustment.

Changes

README URL Migration

Layer / File(s) Summary
Update documentation URLs to img2num.dev
packages/py/README.md
Header badges, demo link, community links table (Docs/Changelog/Blog), API reference link, and footer documentation link are all updated from the old GitHub Pages host to img2num.dev; footer closing div repositioned accordingly.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

Suggested labels: python

Poem

A rabbit hopped through docs and links,
Swapping old hosts for shiny new inks,
img2num.dev now shines so bright,
Badges and footers all set right,
Hop, hop, hooray — the URLs align! 🐇✨

🚥 Pre-merge checks | ✅ 8
✅ Passed checks (8 passed)
Check name Status Explanation
Title check ✅ Passed The title uses a Conventional Commit prefix and clearly describes the README link domain update.
Description check ✅ Passed The description is directly related to the link updates and explains why the domain was changed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
No Ai Slop Pr Description ✅ Passed The PR description names the exact change (link-only README updates) and gives a specific reason: the old ryan-millard.github.io domain was outdated.
No Strangely-Named Root Markdown Files ✅ Passed Only packages/py/README.md changed; no new unconventional markdown files were added at the repository root.
Coderabbit Config Needs Update ✅ Passed Diff only updates links in packages/py/README.md; .coderabbit.yaml is unchanged and no new languages, configs, or file extensions were added.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/py/readme-link-fix
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/py/readme-link-fix

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.

@coderabbitai coderabbitai Bot added the python changes to python bindings or python code label Jul 9, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@packages/py/README.md`:
- Around line 106-107: The Community Links section is missing the required blank
line after the heading, causing the markdown heading spacing rule to fail.
Update the README so the `## Community Links` heading in the relevant section is
followed by an empty line before the badge row, keeping the formatting
consistent with the rest of the document.
- Around line 101-104: Add meaningful alt text to the badge and logo images in
the Python README table so the identifying content is accessible and
markdownlint no longer flags missing alt text. Update the relevant HTML img tags
in the badge rows for the C, C++, JavaScript, and Python package links with
concise descriptions that match their purpose, keeping the rest of the table
structure unchanged.
- Line 111: Update the README blog badge link so it points to the site-root blog
URL instead of the /info/blog/ path. In the Markdown badge entry in
packages/py/README.md, replace the current target used by the Blog badge with
https://img2num.dev/blog/ and keep the badge label/style unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: c0951dd3-fb3f-4281-bf17-5504dacf279b

📥 Commits

Reviewing files that changed from the base of the PR and between 5ebd024 and 74b1505.

📒 Files selected for processing (1)
  • packages/py/README.md
📜 Review details
⏰ Context from checks skipped due to timeout. (4)
  • GitHub Check: Build C/C++ / Build C & C++
  • GitHub Check: Build C/C++ / Build Python
  • GitHub Check: Build C/C++ / Build WASM (bindings/js)
  • GitHub Check: Lint & Validate Code
🧰 Additional context used
📓 Path-based instructions (2)
**/*.md

📄 CodeRabbit inference engine (.editorconfig)

**/*.md: Do not trim trailing whitespace in Markdown files
Use 2-space indentation for Markdown files
Do not enforce maximum line length for Markdown files

Files:

  • packages/py/README.md
**

⚙️ CodeRabbit configuration file

**: # Contributing to Img2Num

Want to contribute to Img2Num? There are a few things you need to know.

We wrote a contribution guide to help you get started.

A few important points:

  • Add tests with your PR — new features and bug fixes must include tests where appropriate. PRs without tests are unlikely to be approved.
  • Follow the repository's coding style rules.
  • Use the issue and PR templates when filing issues or submitting code. Your PR will be rejected if you don't.

If you're unsure what to change, open a discussion and someone will assist you.

Questions?

If you have questions or need help:

Thank you for improving Img2Num! 🎨🚀

**: BasedOnStyle: LLVM
Standard: c++20

--- Basic formatting ---

IndentWidth: 4
ColumnLimit: 100
TabWidth: 4

--- Braces ---

Cpp11BracedListStyle: true
SpaceBeforeCpp11BracedList: true
BreakBeforeBraces: Attach

--- Braced initializers ---

Cpp11BracedListStyle: true

--- Constructor initializer lists ---

PackConstructorInitializers: Never
BreakConstructorInitializers: BeforeComma
ConstructorInitializerIndentWidth: 4

--- Alignment ---

AlignAfterOpenBracket: BlockIndent

--- Pointers ---

PointerAlignment: Left

--- Includes ---

IncludeBlocks: Regroup
SortIncludes: CaseInsensitive

--- Extern "C" cleanliness ---

IndentExternBlock: NoIndent

--- Lambdas ---

AllowShortLambdasOnASingleLine: Inline

--- Functions ---

AllowShortFunctionsOnASingleLine: None

**: root = true

-------------------------

Global defaults

-------------------------

[*]
charset = utf-8
end_of_line = lf
indent_style = space
indent_size = 2
trim_trailing_whitespace = true
insert_final_newline = true
max_line_length = 120

-------------...

Files:

  • packages/py/README.md
🧠 Learnings (1)
📚 Learning: 2026-02-22T15:20:15.304Z
Learnt from: Ryan-Millard
Repo: Ryan-Millard/Img2Num PR: 263
File: docs/docs/internal/core/api-reference.md:13-13
Timestamp: 2026-02-22T15:20:15.304Z
Learning: In Docusaurus projects, Markdown files (*.md, *.mdx) may contain anchor tags with onClick={(e) => { e.preventDefault(); window.location.href = '...'; }} to force a full page navigation, bypassing React SPA routing for static/external paths. Treat this as intentional and do not flag it as redundant in docs contexts. Apply this guidance broadly to Markdown docs across the repository (not just the single file) and focus reviews on more impactful patterns such as accessibility, SEO, and navigation consistency.

Applied to files:

  • packages/py/README.md
🪛 markdownlint-cli2 (0.22.1)
packages/py/README.md

[warning] 101-101: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 101-101: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 102-102: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 102-102: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 103-103: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 103-103: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 104-104: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 104-104: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 106-106: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

🔇 Additional comments (1)
packages/py/README.md (1)

23-24: LGTM!

Also applies to: 60-60, 150-150, 179-179, 192-192

Comment thread packages/py/README.md Outdated
Comment on lines +101 to +104
| <a href="https://github.com/Ryan-Millard/Img2Num/releases?q=bindings-c"><img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/c/c-original.svg" width="30" /></a> | <a href="https://github.com/Ryan-Millard/Img2Num/releases?q=bindings-c"><img src="https://img.shields.io/badge/GitHub_Releases-C_Bindings-A8B9CC?logo=github" /></a> [![Docs](https://img.shields.io/badge/docs-C-A8B9CC?logo=gitbook&logoColor=white)](https://img2num.dev/info/docs/c/) [![C Changelog](https://img.shields.io/badge/changelog-C-A8B9CC?logo=c)](https://img2num.dev/info/changelog/c/) |
| <a href="https://github.com/Ryan-Millard/Img2Num/releases?q=cpp"><img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/cplusplus/cplusplus-original.svg" width="30" /></a> | <a href="https://github.com/Ryan-Millard/Img2Num/releases?q=cpp"><img src="https://img.shields.io/badge/GitHub_Releases-C++-00599C?logo=github" /></a> [![Docs](https://img.shields.io/badge/docs-C++-00599C?logo=gitbook&logoColor=white)](https://img2num.dev/info/docs/cpp/) [![C++ Changelog](https://img.shields.io/badge/changelog-C%2B%2B-00599C?logo=c%2B%2B&logoColor=white)](https://img2num.dev/info/changelog/cpp/) |
| <a href="https://github.com/Ryan-Millard/Img2Num/releases?q=packages-js"><img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/javascript/javascript-original.svg" width="30" /></a> | [![npm](https://img.shields.io/npm/v/img2num?logo=npm)](https://www.npmjs.com/package/img2num) ![Downloads](https://img.shields.io/npm/dm/img2num?logo=npm) <a href="https://github.com/Ryan-Millard/Img2Num/releases?q=packages-js"><img src="https://img.shields.io/badge/GitHub_Releases-JavaScript_Package-F7DF1E?logo=github" /></a> [![Docs](https://img.shields.io/badge/docs-JavaScript-F7DF1E?logo=gitbook&logoColor=white)](https://img2num.dev/info/docs/js/) [![JavaScript Changelog](https://img.shields.io/badge/changelog-JavaScript-F7DF1E?logo=javascript)](https://img2num.dev/info/changelog/js/) |
| <a href="https://github.com/Ryan-Millard/Img2Num/releases?q=packages-py"><img src="https://cdn.jsdelivr.net/gh/devicons/devicon@latest/icons/python/python-original.svg" width="30" /></a> | ![PyPI](https://img.shields.io/pypi/v/img2num?logo=pypi) [![PyPI Downloads](https://img.shields.io/pypi/dm/img2num?logo=pypi)](https://pypi.org/project/img2num/) [![Supported Versions](https://img.shields.io/pypi/pyversions/img2num?logo=python)](https://pypi.org/project/img2num/) <a href="https://github.com/Ryan-Millard/Img2Num/releases?q=packages-py"><img src="https://img.shields.io/badge/GitHub_Releases-Python_Package-3776AB?logo=github" /></a> [![Docs](https://img.shields.io/badge/docs-Python-3776AB?logo=gitbook&logoColor=white)](https://img2num.dev/info/docs/py/) [![Python Changelog](https://img.shields.io/badge/changelog-Python-3776AB?logo=python)](https://img2num.dev/info/changelog/py/) |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Add alt text to the badge images.

These <img> tags are decorative/identifying content but currently lack alt text, which markdownlint flags and which hurts accessibility.

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 101-101: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 101-101: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 102-102: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 102-102: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 103-103: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 103-103: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 104-104: Images should have alternate text (alt text)

(MD045, no-alt-text)


[warning] 104-104: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@packages/py/README.md` around lines 101 - 104, Add meaningful alt text to the
badge and logo images in the Python README table so the identifying content is
accessible and markdownlint no longer flags missing alt text. Update the
relevant HTML img tags in the badge rows for the C, C++, JavaScript, and Python
package links with concise descriptions that match their purpose, keeping the
rest of the table structure unchanged.

Source: Linters/SAST tools

Comment thread packages/py/README.md Outdated
Comment on lines +106 to +107
## Community Links
[![Changelog](https://img.shields.io/badge/Changelog-Full-orange?logo=git&logoColor=white)](https://ryan-millard.github.io/Img2Num/info/changelog/)
[![Changelog](https://img.shields.io/badge/Changelog-Full-orange?logo=git&logoColor=white)](https://img2num.dev/info/changelog/)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Restore the blank line after ## Community Links.

The heading runs straight into the first badge row, so MD022 still fires here.

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 106-106: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@packages/py/README.md` around lines 106 - 107, The Community Links section is
missing the required blank line after the heading, causing the markdown heading
spacing rule to fail. Update the README so the `## Community Links` heading in
the relevant section is followed by an empty line before the badge row, keeping
the formatting consistent with the rest of the document.

Source: Linters/SAST tools

Comment thread packages/py/README.md Outdated
@Ryan-Millard
Ryan-Millard force-pushed the docs/py/readme-link-fix branch from 74b1505 to 5c83e44 Compare July 9, 2026 07:09
@Ryan-Millard
Ryan-Millard merged commit 177b894 into dev Jul 9, 2026
14 checks passed
@Ryan-Millard
Ryan-Millard deleted the docs/py/readme-link-fix branch July 9, 2026 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs python changes to python bindings or python code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant