Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more articles/approaches file docs #494

Merged
merged 1 commit into from Apr 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 14 additions & 2 deletions building/tracks/approaches.md
Expand Up @@ -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/<approach-slug>/content.md`: description of the approach (see [the docs](/docs/building/tracks/practice-exercises#file-approaches-approach-slug-content-md))
- `.approaches/<approach-slug>/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/<approach-slug>/snippet.<approaches.snippet_extension>`.
11 changes: 11 additions & 0 deletions building/tracks/articles.md
Expand Up @@ -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/<article-slug>/content.md`: description of the articleh (see [the docs](/docs/building/tracks/practice-exercises#file-articles-article-slug-content-md))
- `.articles/<article-slug>/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))