ruby / ruby/vscode-typeprof

Broken link in README.md

Open
#286 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
21
Forks
8
PR merge metrics
No merged PRs in 30d

Description

Hi.
I'm not sure if this is the right issue to post this repository, but I found broken link when read README.md Limitation Heading.

https://github.com/ruby/vscode-typeprof?tab=readme-ov-file#limitations

Image

I think it was probably linked to the typeprof documentation, and I'd like to create pull request to fix it.
However, looking at the ruby/typeprof documentation, there doesn't seem to be any documentation on how to use the IDE.
Where should I point this link to?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in README.md at the Limitations heading and inspect the broken link and the referenced TypeProf documentation. Identify an existing IDE-usage destination or confirm that none exists, then update the link so it resolves to the intended documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.