diff --git a/building/tracks/approaches.md b/building/tracks/approaches.md index 8a6ba9ea..d0b3a6f2 100644 --- a/building/tracks/approaches.md +++ b/building/tracks/approaches.md @@ -43,6 +43,18 @@ In general, [Practice Exercises](/docs/building/tracks/practice-exercises) are m 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. -## Configuring +## Files -Make sure to set the `approaches.snippet_extension` field in your [track's `config.json` file](/docs/building/tracks/config-json). +Each approach must add the following two files: + +- `.approaches//content.md`: description of the approach (see [the docs](/docs/building/tracks/practice-exercises#file-approaches-approach-slug-content-md)) +- `.approaches//snippet.txt`: snippet showcasing the approach (see [the docs](/docs/building/tracks/practice-exercises#file-approaches-approach-slug-snippet-txt)) + +You'll then need to add or update: + +- `.approaches/config.json`: metadata for the approaches (see [the docs](/docs/building/tracks/practice-exercises#file-approaches-config-json)) + +### Configuring snippet extension + +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). +If set, the snippet file you need to add must be named `.approaches//snippet.`. diff --git a/building/tracks/articles.md b/building/tracks/articles.md index 9ec30efc..3706acdf 100644 --- a/building/tracks/articles.md +++ b/building/tracks/articles.md @@ -17,3 +17,14 @@ Potential topics an article could explore: ## What exercises to write articles for? Any exercise, as long as there is something interesting to explore. + +## Files + +Each article must add the following two files: + +- `.articles//content.md`: description of the articleh (see [the docs](/docs/building/tracks/practice-exercises#file-articles-article-slug-content-md)) +- `.articles//snippet.md`: snippet showcasing the article (see [the docs](/docs/building/tracks/practice-exercises#file-articles-article-slug-snippet-txt)) + +You'll then need to add or update: + +- `.articles/config.json`: metadata for the articles (see [the docs](/docs/building/tracks/practice-exercises#file-article-config-json))