freeCodeCamp / freeCodeCamp/devdocs
Cleaner HTML
- 主要言語
- Ruby
- スター
- 39.5k
- フォーク
- 2.6k
- 平均マージ
- 4日 32分
- マージ済み PR(30日)
- 13
説明
Ideally, scraped docs would have minimal HTML. However, several docs currently have classes and wrapper elements. There should be a check that can be run after docs are scraped that looks for elements with a `class` or other non-`id` attribute that isn’t referenced by a CSS selector, as well as non-semantic elements with no attributes that are not referenced in the CSS. Then, someone should go through all of the docs to find and eliminate the excess markup. This will most likely result in a decrease in the size of downloaded docs bundles.
- [ ] create linter
- [ ] lint & fix the docs (maybe only do this when updating a doc for other reasons)
コントリビューションガイド
調査の方向性
Start by tracing where scraped HTML is produced and where the documentation CSS selectors are defined. Build the requested post-scrape check around unused classes, non-id attributes, and non-semantic attribute-free elements, then run it across the docs and remove the reported excess markup. Done means the linter works and the docs pass it.
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- css, html, ruby
- 領域
- documentation, tooling
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100