alphagov / alphagov/tech-docs-gem

[Enhancement]: Fix scrolling behaviour so navigation scrolls independently of content

Open
#537 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Ruby
Stars
16
Forks
47
Avg merge
1d 21h
Merged PRs (30d)
14

Description

What should change?

A change was made in PR513 which prevents the table of contents from scrolling independently of the content. This makes the scroll position of the TOC jump around when moving between sections. Ideally they should scroll independently of one another.

User need

Help the user stay oriented in the TOC by keep it in position when they're scrolling through the content.

Proposed solution

No response

Contributor guide

No contributing guide indexed for this repository

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 reviewing PR513 and the current navigation/content scrolling behavior in tech-docs-gem. Reproduce the TOC position jump while moving between sections, then identify the existing scrolling entry point. Done when the TOC stays oriented while the content scrolls independently, with the resulting behavior verified.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.