Skip to content

[v3] Update Markdown files to latest spec #330

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

Merged
merged 2 commits into from
Feb 14, 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).
@mpizenberg mpizenberg merged commit ef43bbe into exercism:main Feb 14, 2021
mpizenberg added a commit that referenced this pull request Feb 16, 2021
mpizenberg added a commit that referenced this pull request Mar 28, 2021
mpizenberg added a commit that referenced this pull request Apr 2, 2021
* Add skeleton for bettys bike shop exercise / foundations concept

* Add test, code and examplar

* Add instructions for bettys bike shop

* Add design document for bettys bike shop

* Add links for foundations concept

* Add foundations concept information

* Update introduction to match about

* Update hints and links, which seem very similar

Maybe I have misunderstood their respective purposes a bit

* Add some full stops in design.md

* Compliance with updated markdown spec in #330

* Move exporting before importing

Exporting introduces the notion of exposing and was already
introduced in the previous concept so putting it first
seems more natural to me.

* Ajustments to the import section

* Tiny fixes in type annotation section

* Adjustment to the string section

* Tiny fixes in instructions

* Rename basics to basics-1

* Rename foundations concept to basics-2

* Split pence to string conversion in to 2 steps

* Rename foundations to basics-2

* Fix typo ELm -> Elm in config.json

* Fix title level of basics-1 concept

* Update bettys-bike-shop config.json to latest spec

* Move concept blurbs to their own .meta/config.json

* Add a missing level 1 title to basics-2/introduction.md

* Small improvements on Betty's introduction.md

* Back-propagate Betty's doc improvement to concept docs

* Add a number section in basics-2 docs

* Update betty's instructions to match the spec

Co-authored-by: Matthieu Pizenberg <matthieu.pizenberg@gmail.com>
Co-authored-by: cedd burge <ceddburge@cedds-MBP.fritz.box>
@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