Allow pinning certain sections in documentation
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 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 小时
- 30 天内合并 PR
- 13
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
freeCodeCamp/devdocs 的其他 Issue
-
docs/improvement
难度 2/5 1-3 小时 新手友好度 62/100
freeCodeCamp/devdocs#1989 · 4 条评论 · 4 个 reaction ·
-
难度 5/5 一周以上 新手友好度 20/100
freeCodeCamp/devdocs#2731 ·
-
feature
难度 5/5 一周以上 新手友好度 25/100
freeCodeCamp/devdocs#2712 ·
-
feature
难度 5/5 一周以上 新手友好度 30/100
freeCodeCamp/devdocs#2683 · 1 条评论 ·
-
feature
难度 4/5 3-5 天 新手友好度 45/100
freeCodeCamp/devdocs#2673 ·
查看 freeCodeCamp/devdocs 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 70/100
-
bug
难度 1/5 1 小时以内 新手友好度 90/100
riscv/riscv-unified-db#2626 ·
-
Component: GLib
难度 2/5 1-3 小时 新手友好度 70/100
-
ds-drift
难度 2/5 1-3 小时 新手友好度 70/100
we-promise/sure#3693 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
simp/pupmod-simp-simp#395 ·