From d85b686b973abe9f0fcd127d7da3c277ee851ed2 Mon Sep 17 00:00:00 2001 From: Erik Schierboom Date: Fri, 12 Feb 2021 15:05:46 +0100 Subject: [PATCH] [v3] Add level one headings to Markdown files. All Markdown files should, from this point on, start with a level one heading. See https://github.com/exercism/configlet/issues/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). --- docs/ABOUT.md | 2 ++ docs/INSTALLATION.md | 2 ++ docs/LEARNING.md | 2 ++ docs/RESOURCES.md | 2 ++ docs/TESTS.md | 2 ++ exercises/practice/bob/.meta/description.md | 2 ++ 6 files changed, 12 insertions(+) diff --git a/docs/ABOUT.md b/docs/ABOUT.md index 5a924d9..b5eaa7e 100644 --- a/docs/ABOUT.md +++ b/docs/ABOUT.md @@ -1,3 +1,5 @@ +# About + Lisp Flavoured Erlang (AKA LFE) is a lisp syntax front-end to the Erlang compiler. Code produced with it is compatible with "normal" Erlang code. LFE is a (proper) Lisp based on the features and limitations of the Erlang VM. diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 668b322..00c21b7 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -1,3 +1,5 @@ +# Installation + First, make sure you have Erlang installed, following the instructions on the [Erlang][1] installation page as appropriate. [1]: /languages/erlang diff --git a/docs/LEARNING.md b/docs/LEARNING.md index a9c24b7..a2bc556 100644 --- a/docs/LEARNING.md +++ b/docs/LEARNING.md @@ -1,3 +1,5 @@ +# Learning + Exercism provides exercises and feedback but can be difficult to jump into for those learning LFE for the first time. These resources can help you get started: diff --git a/docs/RESOURCES.md b/docs/RESOURCES.md index e69de29..06f84ec 100644 --- a/docs/RESOURCES.md +++ b/docs/RESOURCES.md @@ -0,0 +1,2 @@ +# Resources + diff --git a/docs/TESTS.md b/docs/TESTS.md index bf6f9f8..e5681d8 100644 --- a/docs/TESTS.md +++ b/docs/TESTS.md @@ -1,3 +1,5 @@ +# Tests + For each example, the following general steps are required. First, change directory to the exercise you want to practice, in diff --git a/exercises/practice/bob/.meta/description.md b/exercises/practice/bob/.meta/description.md index 1072139..a889ec9 100644 --- a/exercises/practice/bob/.meta/description.md +++ b/exercises/practice/bob/.meta/description.md @@ -1,3 +1,5 @@ +# Description + Bob is a lackadaisical teenager. In conversation, his responses are very limited. Bob answers 'Sure.' if you ask him a question.