Allow pinning certain sections in documentation
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- ruby
調査の方向性
まず README.md にある DevDocs のビジョンを確認し、次に C++ や CSS などのセットでドキュメントのセクションが現在どのように表示されているかを調べます。ドキュメントセットごとにピン留めされたセクションがどのように保存されるのか、また順序をどのように扱うべきかを明確にします。ユーザーがセクションをピン留めでき、一致するページでそれを上部に表示でき、他のドキュメントセットに影響しなければ完了です。
索引モデルが issue の本文から書いたものです。
説明
Feature request
Summary
In documentations a lot of times there are sections that consistently exist across most pages of the docs, for instance in the C++ documentation a lot of times you find that there is an Examples section that shows how to use the function being documented. I would really like to have the example section appear on the top of the page because a lot of times it does a much better job at explaining what the function does and how to use it than the cppreference cryptic definitions.
Examples
I don't have a screenshot of this feature from another source. I think having a pin button next to the sections is a good starting point. When that button is clicked, the section should be added to a list of pinned sections, and whenever the visited page contains that section, it should be displayed at the top of the page. Of course, the pinned sections will be local to each set of docs, so if you pin the Examples section in the C++ docs, it won't be pinned in the CSS docs. This is both simpler to implement and makes sense, since each documentation set has its own structure.
I think this is a solid foundation to build on. From there, you could refine it further, perhaps by adding a settings section in each set of docs where you can view all available sections in those docs and allow the user to drag and drop them into a list to define their preferred order. However, this would 1) be quite challenging to implement and 2) may not be practical in reality.
- 主要言語
- Ruby
- スター
- 39.5k
- フォーク
- 2.6k
- 平均マージ
- 2日 9時間
- マージ済み PR(30日)
- 13
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
freeCodeCamp/devdocs のほかの issue
-
docs/improvement
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
freeCodeCamp/devdocs#1989 · コメント 4 件 · リアクション 4 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
freeCodeCamp/devdocs#2731 ·
-
feature
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
freeCodeCamp/devdocs#2712 ·
-
feature
難易度 5/5 1週間以上 初心者へのやさしさ 30/100
freeCodeCamp/devdocs#2683 · コメント 1 件 ·
-
feature
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
freeCodeCamp/devdocs#2673 ·
freeCodeCamp/devdocs の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
googleapis/google-api-ruby-client#28001 · リアクション 5 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100