getodk / getodk/docs

Hide/Display toggler interferes with anchor links in list items.

Open
#851 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

(This is a funny one.)

The following (I am sad to say) breaks lists (every item is number 1.)

```rst

.. _item-name:

#. Step in this procedure

Details about this step.
```

To fix that, you have to do this:

```rst

#. Step in this procedure

.. _item-name:

Details about this step.
```

Unfortunately this is a problem because when the details are hidden
(which they are at page load)
the anchor target is not there and so the page does not scroll to it.

The answer is fixing the JS that wraps the paragraphs.

Contributor guide

Open the contributing guide

Research direction

Start by locating the JavaScript that wraps paragraphs when details are hidden, then reproduce the reStructuredText example in the issue. Verify that anchor links still find their targets, list numbering remains correct, and hidden details continue to behave as before.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.