Skip to content

Commit a583d5c

Browse files
Create using_help_annotations_correctly.md
1 parent 829b966 commit a583d5c

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## Using help annotations
2+
3+
Whenever using help annotations, please see these 3 steps below.
4+
5+
1. Make sure you first write `github:`, so MakeCode knows to fetch a repository on GitHub
6+
2. Write the repository's name **without any spaces after writing the colon**
7+
3. Add a slash command to tell the compiler to read a specific file in the repository
8+
4. If it is a folder in a repository, write the folder's name and then another slash command
9+
5. Finally, add the file's name (**the file's path must be right or it will not be load**)
10+
6. Also, make sure to **not** add .md in the end of the file path because MakeCode already reads doc files as markdown files.

0 commit comments

Comments
 (0)