Skip to content

Fix example links#218

Merged
panglesd merged 2 commits intomainfrom
fix-example-links
Mar 8, 2026
Merged

Fix example links#218
panglesd merged 2 commits intomainfrom
fix-example-links

Conversation

@panglesd
Copy link
Copy Markdown
Owner

@panglesd panglesd commented Mar 8, 2026

Some target links on preview images were linking to the wrong presentation

Summary by CodeRabbit

  • Documentation
    • Corrected multiple incorrect image target URLs throughout the example documentation to fix broken reference links.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 8, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 03910bb0-dc72-4135-8a05-8bc0505c34d2

📥 Commits

Reviewing files that changed from the base of the PR and between 11c799b and 56d45da.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • docs/examples.rst

📝 Walkthrough

Walkthrough

Documentation example links were corrected. The changelog was updated to document the fix, and multiple image target URLs in the examples documentation were updated to their correct destinations.

Changes

Cohort / File(s) Summary
Documentation and Changelog Updates
CHANGELOG.md, docs/examples.rst
Added changelog entry documenting correction of wrong example links in documentation. Updated multiple image target URLs in examples documentation to correct destinations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Links were broken, now they're fixed with glee,
Our docs shine brighter for all to see,
Each URL corrected with care and grace,
Examples now guide to the proper place! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Fix example links' directly and accurately summarizes the main change: correcting wrong example/preview image target links in the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-example-links

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

@panglesd panglesd merged commit ce82d0a into main Mar 8, 2026
6 of 8 checks passed
panglesd added a commit to panglesd/opam-repository that referenced this pull request Mar 12, 2026
CHANGES:

### Added

- Helpful warnings at compile-time (panglesd/slipshow#213):
  - Action parsing failures,
  - Missing ID (and `external-ids` frontmatter field to selectively deactivate),
  - Duplicated ID,
  - Frontmatter parsing error,
  - Wrong target type for actions,
  - Missing file,
  - Unknown attribute,
  - ...

### Fixed

- Fixed drawing stopping slightly after pauses (panglesd/slipshow#216)
- Fixed keyboard shortcuts not working in serve mode until the preview was
  clicked (panglesd/slipshow#215)
- Fix shortcuts not working after saving a drawing (panglesd/slipshow#217)
- Fix wrong example links in docs (panglesd/slipshow#218)
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