ruby / ruby/rdoc

Variables

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

Nobody has claimed this yet.

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

Description

Asciidoc markup offers the option of variables, or "attributes" as they call
them:

https://asciidoctor.org/docs/user-manual#attributes

it allows you to remove redundancy in a graceful way:

:q: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference

- {q}/Global_Objects/Array/pop
- {q}/Global_Objects/Array/shift
- {q}/Global_Objects/Array/splice

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 with the linked Asciidoctor attributes documentation and inspect how RDoc handles Asciidoc-style markup. Use the sample defining q and referencing it in links as the acceptance case; the work is done when those attributes expand correctly in generated documentation.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.