Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bourdakos1 committed Apr 13, 2020
1 parent c6b9ca4 commit 5a88c71
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Guides
Each markdown file generates an `h1` header for the title and adds it to the sidebar. Only use (`h2`, `h3`, `h4`…) tags for headings in the actual markdown file. Any `h2` tags will generate a sub heading link in the sidebar.

Each markdown file should include a title at the top:
Each markdown file should include a `title` at the top:
```
---
title: Non-interactive training
Expand All @@ -13,15 +13,15 @@ The order of the `guides` are specified in `_config.yml`
## Workshops
Each markdown file generates an `h1` header for the title and adds it to the sidebar. Only use (`h2`, `h3`, `h4`…) tags for headings in the actual markdown file.

Each markdown file should include a title and date at the top:
Each markdown file should include a `title` and `order` at the top:
```
---
title: Preparing training data
date: 1970-01-02
order: 2
---
```

`workshops` are organized/sorted by the date
`workshops` are sorted by `order`

## Copy
When describing UI to click on, use single backticks, for example: Choose `File` > `Export as Create ML`
Expand Down

0 comments on commit 5a88c71

Please sign in to comment.