warriordog/mooltipage

Docs: Semantic HTML fixes

开放

#49 创建于 2020年10月4日

在 GitHub 查看贡献者指南
 (0 条评论) (0 个反应) (0 位负责人)TypeScript (4 个派生)auto 404
documentationenhancementgood first issue

仓库指标

星标
 (1 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

Some parts of the documentation don't make proper use of semantic HTML. These issues should be fixed:

  • Use page-section tag in index.html
  • Split p tags into actual paragraphs in all parts of getting started section
  • Move inline example code into figure tags (!! this might need CSS tweaks)

贡献者指南

研究方向
检查文档文件中非语义HTML的使用情况。将通用的div替换为语义标签，如<section>、<figure>，并将长<p>块拆分为多个段落。对于figure标签的更改，检查现有的CSS或JavaScript是否针对这些元素，并相应调整。
技术栈
typescript
领域
frontenddocumentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
HTML
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85