Skip to content

Commit 7640d7f

Browse files
Add more articles/approaches file docs (#494)
1 parent e452e0b commit 7640d7f

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed

building/tracks/approaches.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,18 @@ In general, [Practice Exercises](/docs/building/tracks/practice-exercises) are m
4343

4444
For [Concept Exercises](/docs/building/tracks/concept-exercises), discussing the exemplar approach might be interesting. For example, you could show how the concept being taught makes certain code easier to write.
4545

46-
## Configuring
46+
## Files
4747

48-
Make sure to set the `approaches.snippet_extension` field in your [track's `config.json` file](/docs/building/tracks/config-json).
48+
Each approach must add the following two files:
49+
50+
- `.approaches/<approach-slug>/content.md`: description of the approach (see [the docs](/docs/building/tracks/practice-exercises#file-approaches-approach-slug-content-md))
51+
- `.approaches/<approach-slug>/snippet.txt`: snippet showcasing the approach (see [the docs](/docs/building/tracks/practice-exercises#file-approaches-approach-slug-snippet-txt))
52+
53+
You'll then need to add or update:
54+
55+
- `.approaches/config.json`: metadata for the approaches (see [the docs](/docs/building/tracks/practice-exercises#file-approaches-config-json))
56+
57+
### Configuring snippet extension
58+
59+
You can also use a custom extension instead of the default `.txt` extension by setting the `approaches.snippet_extension` field in your [track's `config.json` file](/docs/building/tracks/config-json).
60+
If set, the snippet file you need to add must be named `.approaches/<approach-slug>/snippet.<approaches.snippet_extension>`.

building/tracks/articles.md

+11
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,14 @@ Potential topics an article could explore:
1717
## What exercises to write articles for?
1818

1919
Any exercise, as long as there is something interesting to explore.
20+
21+
## Files
22+
23+
Each article must add the following two files:
24+
25+
- `.articles/<article-slug>/content.md`: description of the articleh (see [the docs](/docs/building/tracks/practice-exercises#file-articles-article-slug-content-md))
26+
- `.articles/<article-slug>/snippet.md`: snippet showcasing the article (see [the docs](/docs/building/tracks/practice-exercises#file-articles-article-slug-snippet-txt))
27+
28+
You'll then need to add or update:
29+
30+
- `.articles/config.json`: metadata for the articles (see [the docs](/docs/building/tracks/practice-exercises#file-article-config-json))

0 commit comments

Comments
 (0)