Is text markup a block?

Open
#1,413 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
ruby
Domain
documentation

Research direction

Start by reviewing the markup reference and how it currently categorizes text markup alongside paragraphs, lists, and headings. Determine whether that classification is useful or whether text markup belongs as an embeddable element, then update the reference to document the chosen model and its implications.

Written by the indexing model from the issue text.

Description

documentation

In the markup reference, I've included text markup as a type of block (along with paragraph, list, heading, etc.). But is it really useful to think of text markup in this way? Would it be better to treat text markup as embed-able in certain other blocks?

Dominant language
Ruby
Stars
930
Forks
472
Avg merge
2d 8h
Merged PRs (30d)
12

Getting set up

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.

More from ruby/rdoc

All issues in ruby/rdoc

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.