Improve usability of documentation
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- css, javascript
- 领域
- design, documentation, frontend
调研方向
首先检查文档网站的页面布局和样式，然后将 TOC 和排版与链接中的 Lodash、React、Fluent UI 和 Flutter 示例进行比较。当文档具有固定且可折叠的 TOC，并且在桌面端采用更舒适的字体大小和行高时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
- Please provide a fixed left sidebar for TOC (Table of Contents). Currently, the TOC scrolls with the content which is uncomfortable. And please use toggles for the main concepts of the TOC. Currently, the user must scroll a lot up and down. For inspiration, look at
- https://lodash.com/docs/4.17.15 (fixed left sidebar with collapsable items for TOC)
- https://reactjs.org/docs/getting-started.html (fixed right sidebar with collapsable items for TOC)
- https://developer.microsoft.com/en-us/fluentui#/controls/web/button (fixed left sidebar with collapsable items for TOC)
- https://flutter.dev/docs (fixed left sidebar with collapsable items for TOC)
- And please consider to use another more readable font for better readability. At least, make the font-size and line-height a little smaller. Currently, the font-size (for desktop) is 16 (and line height is 1.6) which is, in my opinion, very uncomfortable to read. Compare the font (size and line-height) with the others example above (which uses, for example, font-size: 14, line-height: 1.3).
- 主要语言
- JavaScript
- 星标
- 163
- 派生
- 429
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
framework7io/framework7-website 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 65/100
-
难度 2/5 1-3 小时 新手友好度 58/100
-
难度 3/5 1-2 天 新手友好度 25/100
-
难度 1/5 1 小时以内 新手友好度 45/100
-
难度 1/5 1-3 小时 新手友好度 58/100
查看 framework7io/framework7-website 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 2 天内回复
-
area-clientside-dartpad
难度 2/5 1-3 小时 新手友好度 66/100
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
alphagov/public-asset-checker#378 · 1 条评论 ·
维护者通常 1 天内回复
-
S: triage
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
apache/rocketmq-dashboard#7242 ·
维护者通常 3 天内回复