Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CannonLock authored Jan 19, 2024
1 parent ca3a6e7 commit ed3fccc
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,16 +181,23 @@ To add a tutorial you need to do two things:

#### Add the tutorial as a submodule in the tutorial directory

When running the script below confirm that that submodule gets cloned into the folder that you identify.
If the repo you are hoping to add does not show up please reach out to Cannon.

```
# From repo root
# Replace <git-url> and <tutorial-name> before running
git submodule add <git-url> ./documentation/tutorials/<tutorial-name>
git submodule add <https://github-url.git> ./documentation/tutorials/<tutorial-name>
```
#### Add the appropriate frontmatter so the the README is linked correctly
Read more [above](#creating-the-document)
#### Add the document to the websites navigation
Read more [above](#adding-it-to-the-navigation)
### Documentation Style Guide
#### One top level header per page
Expand Down

0 comments on commit ed3fccc

Please sign in to comment.