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

[v3] Update Markdown files to latest spec #2344

Merged
merged 2 commits into from
Mar 1, 2021

Conversation

ErikSchierboom
Copy link
Member

We've defined a specification for Markdown files to be applied Exercism-wide. This standard includes, amongst others, the following two rules:

  • All files must start start with a level-1 heading (# Some heading text)
  • No heading may decend a level greater than one below the previous (e.g. ## may only be followed by ###, not ####)

This PR applies the above two rules to the Markdown documents in this repo.

Tracking

exercism/v3-launch#17

All Markdown files should, from this point on, start with a level one heading.
See exercism/configlet#150 for the rationale behind these changes.

The full specification can be found [here](https://github.com/exercism/docs/blob/main/contributing/standards/markdown.md).
@ErikSchierboom ErikSchierboom requested a review from a team as a code owner February 12, 2021 14:08
Copy link
Member

@BethanyG BethanyG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finally got to this, and things look good to merge. 🌟
Thank you for PRing this, @ErikSchierboom!

@BethanyG BethanyG merged commit a768915 into exercism:main Mar 1, 2021
@ErikSchierboom ErikSchierboom added the x:size/tiny Tiny amount of work label Oct 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
x:size/tiny Tiny amount of work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants