Skip to content

Conversation

@vinistock
Copy link
Member

@vinistock vinistock commented Dec 24, 2025

Motivation

I noticed that the read more links weren't working. The reason is because Markdown links always need to use URIs and not file paths.

Implementation

Corrected the links to use URIs.

Automated Tests

Updated the tests, which were asserting the wrong behaviour.

@vinistock vinistock self-assigned this Dec 24, 2025
@vinistock vinistock added the bugfix This PR will fix an existing bug label Dec 24, 2025 — with Graphite App
Copy link
Member Author


How to use the Graphite Merge Queue

Add the label graphite-merge to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@vinistock vinistock added the server This pull request should be included in the server gem's release notes label Dec 24, 2025 — with Graphite App
@vinistock vinistock marked this pull request as ready for review December 24, 2025 14:01
@vinistock vinistock requested a review from a team as a code owner December 24, 2025 14:01
@vinistock vinistock enabled auto-merge (squash) December 24, 2025 14:01
@st0012
Copy link
Member

st0012 commented Dec 24, 2025

If we use yield as an example, there should we take user for the doc?
I'm on v0.26.4 and clicking the read more for yield opens /Users/hung-wulo/.gem/ruby/3.4.0/gems/ruby-lsp-0.26.4/static_docs/yield.md in my editor. Is this the expected behaviour?

@vinistock
Copy link
Member Author

I'm on v0.26.4 and clicking the read more for yield opens /Users/hung-wulo/.gem/ruby/3.4.0/gems/ruby-lsp-0.26.4/static_docs/yield.md in my editor. Is this the expected behaviour?

Yup. We ship the static docs as part of the gem so that we can open expanded documentation directly in the editor.

Without this fix, the link doesn't even render because the editor expects URIs and not file paths.

@st0012
Copy link
Member

st0012 commented Dec 24, 2025

Screenshot 2025-12-24 at 14 26 58

But it does render for me 🤔
I'm not on this branch. I'm using the v0.26.4 release in the RDoc codebase

@vinistock
Copy link
Member Author

Oh, weird. I'm not sure why I can't see the links if they are not URIs. Do you still see them on this branch?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfix This PR will fix an existing bug server This pull request should be included in the server gem's release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants