Skip to content

Commit

Permalink
[v3] Add level one headings to Markdown files. (#295)
Browse files Browse the repository at this point in the history
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).
  • Loading branch information
ErikSchierboom authored Feb 17, 2021
1 parent b0e204c commit 8ec254f
Show file tree
Hide file tree
Showing 29 changed files with 56 additions and 2 deletions.
2 changes: 2 additions & 0 deletions concepts/callbacks/about.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# About

TODO: add information on callbacks concept
2 changes: 2 additions & 0 deletions concepts/callbacks/introduction.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Introduction

TODO: add introduction for callbacks concept
2 changes: 2 additions & 0 deletions concepts/errors-basic/about.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# About

TODO: add information on errors-basic concept
2 changes: 2 additions & 0 deletions concepts/errors-basic/introduction.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Introduction

TODO: add introduction for errors-basic concept
2 changes: 2 additions & 0 deletions concepts/futures/about.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# About

TODO: add information on futures concept
2 changes: 2 additions & 0 deletions concepts/futures/introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Introduction

TODO: the content below is copied from the exercise introduction and probably needs rewriting to a proper concept introduction

## futures
2 changes: 2 additions & 0 deletions concepts/iterables-basic/about.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# About

TODO: add information on iterables-basic concept
2 changes: 2 additions & 0 deletions concepts/iterables-basic/introduction.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Introduction

TODO: add introduction for iterables-basic concept
2 changes: 2 additions & 0 deletions concepts/numbers-basic/about.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# About

TODO: add information on numbers-basic concept
2 changes: 2 additions & 0 deletions concepts/numbers-basic/introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Introduction

TODO: the content below is copied from the exercise introduction and probably needs rewriting to a proper concept introduction

## numbers-basic
Expand Down
2 changes: 2 additions & 0 deletions concepts/recursion/about.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# About

TODO: add information on recursion concept
2 changes: 2 additions & 0 deletions concepts/recursion/introduction.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Introduction

TODO: add introduction for recursion concept
2 changes: 2 additions & 0 deletions concepts/strings-basic/about.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# About

TODO: add information on strings-basic concept
2 changes: 2 additions & 0 deletions concepts/strings-basic/introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Introduction

Strings are useful for holding data that can be represented in text form. Some
of the most-used operations on strings are to check their `length`, to build
and concatenate them using the `+` and `+=` string operators, checking for the
Expand Down
2 changes: 2 additions & 0 deletions concepts/type-conversion/about.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# About

TODO: add information on type-conversion concept
2 changes: 2 additions & 0 deletions concepts/type-conversion/introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Introduction

TODO: the content below is copied from the exercise introduction and probably needs rewriting to a proper concept introduction

## numbers-basic
Expand Down
2 changes: 2 additions & 0 deletions docs/ABOUT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# About

Dart brings object-oriented and typing together with the flexibility that JavaScript is known for. It is designed to simplify common programming tasks. In recent years, its popularity in the software development community has grown tremendously.

To dig deeper into Dart, [click here](https://www.dartlang.org/guides/language/language-tour).
Expand Down
2 changes: 2 additions & 0 deletions docs/INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Installation

## Installing Dart

### Automatic installation instructions (recommended)
Expand Down
2 changes: 1 addition & 1 deletion docs/LEARNING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Recommended Learning Resources
# Recommended Learning Resources
* [Dart Language Overview](https://www.dartlang.org/guides/language/language-tour)
* [Getting Started](https://www.dartlang.org/tutorials/dart-vm/get-started)
* [Make a command line app](https://www.dartlang.org/tutorials/dart-vm/cmdline)
Expand Down
2 changes: 2 additions & 0 deletions exercises/concept/futures/.docs/hints.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Hints

2 changes: 2 additions & 0 deletions exercises/concept/futures/.docs/instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Instructions

2 changes: 2 additions & 0 deletions exercises/concept/futures/.docs/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Introduction

2 changes: 2 additions & 0 deletions exercises/concept/numbers/.docs/hints.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Hints

2 changes: 2 additions & 0 deletions exercises/concept/numbers/.docs/instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Instructions

2 changes: 2 additions & 0 deletions exercises/concept/numbers/.docs/introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Introduction

## Numbers Basic

## Type Conversion
2 changes: 2 additions & 0 deletions exercises/concept/strings/.docs/hints.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Hints

2 changes: 2 additions & 0 deletions exercises/concept/strings/.docs/instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Instructions

2 changes: 2 additions & 0 deletions exercises/concept/strings/.docs/introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Introduction

Strings are useful for holding data that can be represented in text form. Some
of the most-used operations on strings are to check their `length`, to build
and concatenate them using the `+` and `+=` string operators, checking for the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Tip
# Tip

A function with a *return type* can only return data of that *type* and `null`.
However the function caller is only expecting one data type.
Expand Down

0 comments on commit 8ec254f

Please sign in to comment.