freeCodeCamp / freeCodeCamp/devdocs

Cleaner HTML

Open
#1,179 2 comments 0 reactions 0 assignees View on GitHub
docs/improvement improvement
Dominant language
Ruby
Stars
39.5k
Forks
2.6k
Avg merge
4d 32m
Merged PRs (30d)
13

Description

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)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.