ruby / ruby/rdoc

Aliki: Add go-to-ruby playground link to Ruby code blocks

Open
#1,452 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Ruby
Stars
930
Forks
465
Avg merge
3d 10h
Merged PRs (30d)
27

Description

Since it's possible to pass code param to try.ruby-lang.org/ruby.github.io, we can add links to it with the code block's code embedded in the parameter. Then the reader can easily play with the code in the browser.

Contributor guide

Open the contributing guide

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 by locating Aliki's Ruby code-block rendering path and reviewing how generated documentation links are tested. Check the try.ruby-lang.org and ruby.github.io playground parameter behavior, then verify that Ruby code blocks produce a usable link with the block code embedded in the parameter.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.