[Enhancement]: TOC lacks active section highlighting and auto-scroll
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 48/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- html
- 領域
- frontend
調査の方向性
Issue にリンクされているチュートリアルページから始め、右側の TOC をレンダリングしているテンプレートまたはコンポーネントを特定します。見出しとスクロールが現在どのように処理されているかを確認します。長いチュートリアルを読んでいる間、表示中のセクションが強調表示され、TOC がそのエントリを表示領域内に保持すれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Description
On the tutorial pages for example, The Basic Tools of the Deep Life Sciences, the right-hand sidebar containing the Table of Contents (TOC) for the current page has two usability issues:
- No Active Section Highlighting (Scrollspy): As the user scrolls through the main document, the TOC does not highlight or indicate which section is currently being read.
- No Auto-scrolling: The TOC does not scroll automatically to keep the active section in view or as the user progresses deep into the document.
Enhancement
- Active state: The section currently in the viewport on the main page should be highlighted in the right TOC ( a scrollspy feature).
- Auto-scroll: The TOC should ideally scroll to ensure the currently active section remains visible within the sidebar.
Expected Outcome
It will look something like this (TOC on the right):
https://github.com/user-attachments/assets/874d7019-45e9-4af0-b587-4e726c4dfca1
Why it matters
Adding this would:
- Make it easier for users to navigate long tutorials without losing their place.
- Improve the overall usability and polish of the tutorials, which are often a new user's first hands-on introduction to DeepChem.
- 主要言語
- HTML
- スター
- 4
- フォーク
- 18
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトの環境構築ファイルはまだ確認していません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
deepchem/deepchem.github.io のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
deepchem/deepchem.github.io#50 · コメント 2 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 45/100
deepchem/deepchem.github.io の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
microsoft/vscode-livepreview#876 ·
メンテナーはふだん 1 日以内に返信
-
domain/crm-after-sales Platform(Default) priority/high
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
ICP 1.2.0 shows a scheduled task's interval in milliseconds under the label "Interval (In seconds)"オープンNeeds Triage Type/Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
wso2/product-integrator#2585 ·
メンテナーはふだん 1 日以内に返信
-
design
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
MTES-MCT/monitor-field#119 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
linagora/twake-calendar-frontend#1443 ·
メンテナーはふだん 1 日以内に返信