Commit cbb310c0 authored by Greg Wilson's avatar Greg Wilson
Browse files

Spell-checking

parent fdce51e6
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -37,7 +37,7 @@ including detailed instructions on design, setup, and formatting.
7.  If you find an error or omission in this documentation,
    please [file an issue in this repository][example-issues].
    If you find an error or omission in the lesson template,
    please [file an issue in the stles repository][styles-issues] instead.
    please [file an issue in the styles repository][styles-issues] instead.

## Layout

+1 −1
Original line number Diff line number Diff line
@@ -61,7 +61,7 @@ we design lessons in four stages:
    there are often several different orders in which ideas can sensibly be introduced.
    It is common to discover a need for more formative assessments at this stage;
    to continue with the driving example,
    the lesson author might realize that a third exericse on turning while backing up is needed
    the lesson author might realize that a third exercise on turning while backing up is needed
    (since many people initially turn the steering wheel the wrong way when they're in reverse).

In practice, the process often looks more like this:
+1 −1
Original line number Diff line number Diff line
@@ -100,7 +100,7 @@ look for uses of `{USERNAME}`, `{LESSON-NAME}`, `{LESSON-TITLE}`, and `{SITE-NAM

*   `title` is the title of your lesson,
    e.g.,
    "Defense Against the Dark Arts".
    "Defence Against the Dark Arts".

*   `repo` is the URL for your repository on GitHub *without* a trailing slash,
    e.g., `https://github.com/username/subject`.
+1 −0
Original line number Diff line number Diff line
@@ -144,6 +144,7 @@ in case we decide to adopt syntax highlighting at some point:

*   `.bash`: Bash shell commands
*   `.make`: Makefiles
*   `.matlab`: MATLAB source
*   `.python`: Python source
*   `.r`: R source
*   `.sql`: SQL source
+1 −1
Original line number Diff line number Diff line
@@ -9,7 +9,7 @@ objectives:
- "Run the lesson checking script and interpret its output correctly."
- "Preview a lesson locally."
keypoints:
- "Lessons are checked by runnin `make lesson-check`."
- "Lessons are checked by running `make lesson-check`."
- "The checker uses the same Markdown parser as Jekyll."
- "Lessons can be previewed by running `make serve`."
---