Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update order of headings to be semantically correct #1335

Merged
merged 3 commits into from Sep 7, 2022
Merged

docs: update order of headings to be semantically correct #1335

merged 3 commits into from Sep 7, 2022

Conversation

mnigh
Copy link
Contributor

@mnigh mnigh commented Sep 6, 2022

These changes ensures that headings are in a logical order in several files using markdown.

For example, the heading level following an h1 element should be an h2 element, not an h3 element.

source: https://dequeuniversity.com/rules/axe/4.4/heading-order

@mnigh mnigh requested a review from a team September 6, 2022 14:26
@mnigh mnigh requested a review from a team as a code owner September 6, 2022 14:26
@xDivisionByZerox
Copy link
Member

Can you provide a description that explains the change you did here? If possible, link to some sources about "semantically correct HTML".

@xDivisionByZerox xDivisionByZerox added the c: docs Improvements or additions to documentation label Sep 6, 2022
@xDivisionByZerox xDivisionByZerox added this to the v7 - Current Major milestone Sep 6, 2022
@xDivisionByZerox xDivisionByZerox added the p: 1-normal Nothing urgent label Sep 6, 2022
@codecov
Copy link

codecov bot commented Sep 6, 2022

Codecov Report

Merging #1335 (fc95249) into main (bf1ea09) will increase coverage by 0.00%.
The diff coverage is n/a.

❗ Current head fc95249 differs from pull request most recent head aed746f. Consider uploading reports for the commit aed746f to get more accurate results

@@           Coverage Diff           @@
##             main    #1335   +/-   ##
=======================================
  Coverage   99.62%   99.63%           
=======================================
  Files        2163     2163           
  Lines      240701   240701           
  Branches     1014     1018    +4     
=======================================
+ Hits       239794   239818   +24     
+ Misses        886      862   -24     
  Partials       21       21           
Impacted Files Coverage Δ
src/modules/internet/user-agent.ts 88.09% <0.00%> (+6.34%) ⬆️

@ST-DDT
Copy link
Member

ST-DDT commented Sep 6, 2022

Is this worth adding an eslint rule(s)?

@ST-DDT ST-DDT enabled auto-merge (squash) September 7, 2022 16:03
@ST-DDT ST-DDT merged commit e7471b7 into faker-js:main Sep 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

5 participants