ruby / ruby/rdoc

Aliki(?): sidebar should be expanded to show current namespacing

Open
#1,556 0 comments 1 reaction 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

example: https://minite.st/docs/Minitest/Spec/DSL/InstanceMethods.html

should show that whole namespace in the sidebar so you can see siblings, aunts, uncles, etc.

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 example page at https://minite.st/docs/Minitest/Spec/DSL/InstanceMethods.html and inspect how its sidebar is generated. Trace the RDoc code responsible for navigation, then determine how the full namespace and related entries should appear; done means the sidebar exposes the surrounding namespace for this example.

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
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.