Skip to content

docs: host README media on website#1727

Merged
rabanspiegel merged 1 commit intomainfrom
emdash/docs-links-kjis8
Apr 16, 2026
Merged

docs: host README media on website#1727
rabanspiegel merged 1 commit intomainfrom
emdash/docs-links-kjis8

Conversation

@rabanspiegel
Copy link
Copy Markdown
Contributor

@rabanspiegel rabanspiegel commented Apr 16, 2026

Summary

  • Point README download/product images at emdash.sh-hosted media assets
  • Replace local README docs references with public emdash.sh/docs links
  • Remove the old local README media files from docs/public/media

Validation

  • pnpm exec prettier --check README.md

Note

Low Risk
Documentation-only changes; the main risk is broken external URLs or missing hosted assets.

Overview
README now loads download buttons and the product image from https://emdash.sh/media/readme/... instead of ./docs/public/media/....

It also replaces repo-local documentation references (e.g., telemetry and SSH setup/architecture) with their corresponding public emdash.sh/docs pages.

Reviewed by Cursor Bugbot for commit 091afc4. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • Documentation
    • Updated README links and image references to point to externally hosted documentation and assets for improved content organization and accessibility.

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Apr 16, 2026 9:21am

Request Review

Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 16, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

README.md updated with external URLs for assets and documentation references, replacing local relative paths to images and markdown files with absolute URLs hosted on emdash.sh domain.

Changes

Cohort / File(s) Summary
Documentation Links and Assets
README.md
Replaced local relative image paths (./docs/public/media/...) with absolute URLs (https://emdash.sh/media/readme/...). Updated documentation references from local markdown files to external documentation pages on emdash.sh for telemetry and SSH setup topics.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Links now hop to distant shores,
From local paths to emdash doors,
The README gleams with URLs bright,
Documentation in the cloud's sweet light! 🌐

🚥 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 'docs: host README media on website' clearly and concisely summarizes the main change: migrating README assets from local paths to web-hosted URLs.
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
  • Commit unit tests in branch emdash/docs-links-kjis8

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 and usage tips.

@rabanspiegel rabanspiegel merged commit b9c2962 into main Apr 16, 2026
5 of 6 checks passed
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