Skip to content

Highlight the R and Python packages - #1773

Merged
giswqs merged 2 commits into
mainfrom
docs/r-package-badges
Aug 8, 2026
Merged

Highlight the R and Python packages#1773
giswqs merged 2 commits into
mainfrom
docs/r-package-badges

Conversation

@giswqs

@giswqs giswqs commented Aug 8, 2026

Copy link
Copy Markdown
Member

Summary

  • add an R package badge to the README and Getting Started page
  • mention both the Python and R packages in the README overview
  • add direct Python and R package links to the primary usage list

Validation

  • pre-commit run --files README.md docs/getting-started.md
  • MkDocs site build
  • git diff --check

Summary by CodeRabbit

  • Documentation
    • Added an R package badge linking to the GeoLibre R package site.
    • Added README links for using GeoLibre’s Python and R packages.
    • Updated the getting-started page with the new R package badge.

@coderabbitai

coderabbitai Bot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 4a28a92b-47be-4971-ae61-d1294cef0bbf

📥 Commits

Reviewing files that changed from the base of the PR and between 7238e82 and dcd7f11.

📒 Files selected for processing (2)
  • README.md
  • docs/getting-started.md

📝 Walkthrough

Walkthrough

The documentation adds R package badges to the README and Getting Started page. The README also links to Python and R package usage across notebooks, RStudio, Quarto, R Markdown, and Shiny.

Changes

Documentation discoverability

Layer / File(s) Summary
Package and platform links
README.md, docs/getting-started.md
The documentation links to the R package, adds R package badges, and describes Python and R integrations.

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

Possibly related PRs

Poem

I’m a rabbit with links in my den,
R badges now shine bright again.
Python and R paths clearly displayed,
Notebook and Shiny routes laid.
Hop through the docs with cheerful delight!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the changes that highlight the R and Python packages.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/r-package-badges

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.

@giswqs
giswqs marked this pull request as ready for review August 8, 2026 05:27
Copilot AI lite review requested due to automatic review settings August 8, 2026 05:27

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

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

@github-actions

github-actions Bot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

This is consistent with the existing badge style (custom color + logo, matching Microsoft Store/Mac App Store/Google Play patterns). Everything checks out — this is a clean, low-risk docs change. No inline comments needed given the trivial and correct nature of the diff.

Code review

Bugs: None found. The diff is a straightforward two-line README/docs addition; both new links (https://r.geolibre.app/, https://geolibre.app/python/) resolve to nav entries that already exist in mkdocs.yml (r.md, python.md), and docs/r.md already exists in the repo, so the R badge isn't pointing at a nonexistent page. Confidence: high.

Security: None. Static markdown/badge links only, no scripts or executable content. Confidence: high.

Performance: N/A — docs-only change.

Quality:

  • Minor: the PR description says it will "mention both the Python and R packages in the README overview," but the diff only adds them to the bullet list — the actual overview paragraph (README.md:20 / docs/getting-started.md:19) is unchanged and still only says "inside Jupyter notebooks" without naming Python or R explicitly. Not a defect in the shipped text, just a minor mismatch between the PR description and the actual diff. Confidence: medium.
  • The new R badge (276DC3 color, logo=r) follows the same custom-badge convention used for Microsoft Store/Mac App Store/Google Play, so it's stylistically consistent with the rest of the badge row. Confidence: high (no issue).

CLAUDE.md: No violations — this change doesn't touch any of the guarded files/constants called out in CLAUDE.md (whitebox catalog, distance params, CSP allowlist, etc.), and docs-only changes have no build/test gate implications here.

No inline comments were posted; the change is trivial and correct as written.

@giswqs
giswqs merged commit 1196333 into main Aug 8, 2026
8 of 10 checks passed
@giswqs
giswqs deleted the docs/r-package-badges branch August 8, 2026 05:30
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