You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Use this issue template to describe how to add a new reference doc. Only suggest adding a new reference doc when no appropriate online resource can be found. Please fill in the issue template, and remove any sections wrapped in square brackets (such as this section!).]
12
+
[Use this issue template to describe how to add a new reference doc. Only suggest adding a new reference doc when no existing reference document has been written. Please fill in the issue template, and remove any sections wrapped in square brackets (such as this section!).]
12
13
13
-
This issue describes how to add a new <LANG> reference document: <DOC>.
14
+
This issue describes how to add a new reference document: <DOC>.
14
15
15
16
## Description
16
17
17
-
[A clear description of what information the reference document aims to teach. It should be clear how this document can help a student.
18
-
19
-
For example:
20
-
21
-
There are multiple uses of feature `X` in language `Y`. While...]
22
-
23
-
## Resources to refer to
24
-
25
-
[List additional rescources to link to from the document.
18
+
[A clear description of what information the reference document should contain. This document should help other maintainers developing and building context exercises.
---[Use this issue template to describe how to add a new student-facing document. Only suggest adding a new student-facing document when no appropriate online resource can be found. Please fill in the issue template, and remove any sections wrapped in square brackets (such as this section!).]
9
+
10
+
This issue describes how to add a new <LANG> student-facing document: <DOC>.
11
+
12
+
## Description
13
+
14
+
[A clear description of what information the student-facing document should contain. It should be clear how this document can help a student.
15
+
16
+
For example:
17
+
18
+
There are multiple uses of feature `X` in language `Y`. While...]
19
+
20
+
## Resources to refer to
21
+
22
+
[List additional rescources to link to from the document.
Copy file name to clipboardexpand all lines: docs/maintainers/writing-a-concept-exercise-github-issue.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,10 @@ The GitHub issues we create for Concept Exercises need to contain quite a lot of
4
4
5
5
We have provided an [Issue Template](https://github.com/iHiD/v3/issues/new?assignees=&labels=type%2Fnew-exercise%2C+status%2Fhelp-wanted&template=implement-concept-exercise.md&title=%5B%3CLANG%3E%5D+Implement+new+concept+exercise%3A+%3CSLUG%3E) that needs to be filled in for each exercise. Part of that template requires an guide on how to implement the Concept Exercise for the specific track.
6
6
7
-
To help with that, each track should create a standard "Implementation Guide", which can be copy+pasted into the new issue. That file should be stored in `languages/$SLUG/docs/implementing-a-concept-exercise.md`
7
+
To help with that, each track should create a standard "Implementation Guide", which can be copy+pasted into the new issue. That file should be stored in `languages/$SLUG/reference/implementing-a-concept-exercise.md`
8
8
9
9
To make this as straightforward as possible for you, we have provided:
10
10
11
-
-[A sample C# issue](../../languages/csharp/docs/examples/new-concept-exercise-arrays.md) to give you an idea of how a finished issue should look.
12
-
-[The C# implementation file](../../languages/csharp/docs/implementing-a-concept-exercise.md) to be clear on how this specific section should look
11
+
-[A sample C# issue](../../languages/csharp/reference/examples/new-concept-exercise-arrays.md) to give you an idea of how a finished issue should look.
12
+
-[The C# implementation file](../../languages/csharp/reference/implementing-a-concept-exercise.md) to be clear on how this specific section should look
13
13
-[A base file](./generic-how-to-implement-a-concept-exercise.md) for you to work from.
Copy file name to clipboardexpand all lines: languages/coffeescript/reference/implementing-a-concept-exercise.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -2,4 +2,4 @@
2
2
3
3
TODO: describe how to implement a concept exercise for the CoffeeScript track. For inspiration, check out the [C# version of this file][csharp-implementing].
Copy file name to clipboardexpand all lines: languages/cpp/reference/README.md
-10
Original file line number
Diff line number
Diff line change
@@ -124,16 +124,6 @@ The concept exercises use the following concepts:
124
124
125
125
This also indicates that for example `strings-basic` does **not** teach using custom formatting strings and that `numbers-basic` does **not** teach about integer undefined-behavior.
126
126
127
-
## Reference docs
128
-
129
-
Reference docs are written to help explain a particular C++ concept to a student when no appropriate online document can be found. They will be used when creating exercises and as references in exercise documentation.
-[New reference doc (readonly vs const)](examples/new-reference-doc-readonly-vs-const.md)
5
+
Student-facing documents are written to help explain a particular C# concept to a student when no appropriate online document can be found. They will be used when creating exercises and as references in exercise documentation.
6
+
7
+
The following student-facing documents have been written:
8
+
9
+
-[Assemblies][assemblies]
10
+
-[Code style][code_style]
11
+
-[Memory allocation][memory_allocation]
12
+
13
+
The following student-facing documents should be written:
14
+
15
+
- Difference between `static readonly` and `const`
Copy file name to clipboardexpand all lines: languages/csharp/reference/README.md
-18
Original file line number
Diff line number
Diff line change
@@ -180,29 +180,12 @@ The concept exercises use the following concepts:
180
180
181
181
This also indicates that for example `strings-basic` does **not** teach using custom formatting strings and that `numbers-basic` does **not** teach about checked/unchecked arithmetic.
182
182
183
-
## Reference docs
184
-
185
-
Reference docs are written to help explain a particular C# concept to a student when no appropriate online document can be found. They will be used when creating exercises and as references in exercise documentation.
186
-
187
-
The following reference docs have been written:
188
-
189
-
-[Assemblies][assemblies]
190
-
-[Code style][code_style]
191
-
-[Memory allocation][memory_allocation]
192
-
193
-
The following reference docs should be written:
194
-
195
-
- Reference doc on difference between `static readonly` and `const`
Copy file name to clipboardexpand all lines: languages/delphi/reference/implementing-a-concept-exercise.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -2,4 +2,4 @@
2
2
3
3
TODO: describe how to implement a concept exercise for the Delphi track. For inspiration, check out the [C# version of this file][csharp-implementing].
Copy file name to clipboardexpand all lines: languages/elixir/reference/implementing-a-concept-exercise.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -2,4 +2,4 @@
2
2
3
3
TODO: describe how to implement a concept exercise for the Elixir track. For inspiration, check out the [C# version of this file][csharp-implementing].
Copy file name to clipboardexpand all lines: languages/emacs-lisp/reference/implementing-a-concept-exercise.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -2,4 +2,4 @@
2
2
3
3
TODO: describe how to implement a concept exercise for the Emacs Lisp track. For inspiration, check out the [C# version of this file][csharp-implementing].
Copy file name to clipboardexpand all lines: languages/erlang/reference/implementing-a-concept-exercise.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -2,4 +2,4 @@
2
2
3
3
TODO: describe how to implement a concept exercise for the Erlang track. For inspiration, check out the [C# version of this file][csharp-implementing].
Copy file name to clipboardexpand all lines: languages/factor/reference/implementing-a-concept-exercise.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -2,4 +2,4 @@
2
2
3
3
TODO: describe how to implement a concept exercise for the Factor track. For inspiration, check out the [C# version of this file][csharp-implementing].
-[How to implement a Concept Exercise](./implementing-a-concept-exercise.md)
5
+
Student-facing documents are written to help explain a particular F# concept to a student when no appropriate online document can be found. They will be used when creating exercises and as references in exercise documentation.
6
+
7
+
The following student-facing documents have been written:
8
+
9
+
-[Assemblies][assemblies]
10
+
11
+
The following student-facing documents should be written:
0 commit comments