Skip to content

Commit 038ecc8

Browse files
1ethanhanseniHiDthinkverseErikSchierboomee7
authored
fix: add missing info about docs/config.json (#429)
* fix: add missing info about docs/config.json * Apply suggestions from code review Co-authored-by: Kim Hallberg <[email protected]> * Apply suggestions from code review * Update building/tracks/docs.md Co-authored-by: Kim Hallberg <[email protected]> * Update docs.md * Update building/tracks/docs.md Co-authored-by: Erik Schierboom <[email protected]> * Update building/tracks/docs.md Co-authored-by: ee7 <[email protected]> * Update building/tracks/docs.md Co-authored-by: ee7 <[email protected]> --------- Co-authored-by: Jeremy Walker <[email protected]> Co-authored-by: Kim Hallberg <[email protected]> Co-authored-by: Erik Schierboom <[email protected]> Co-authored-by: ee7 <[email protected]>
1 parent ec98b16 commit 038ecc8

File tree

1 file changed

+52
-1
lines changed

1 file changed

+52
-1
lines changed

building/tracks/docs.md

+52-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ docs
1010
├── SNIPPET.txt (required)
1111
├── REPRESENTER_NORMALIZATIONS.md (optional)
1212
├── RESOURCES.md (required)
13-
└── TESTS.md (required)
13+
├── TESTS.md (required)
14+
└── config.json (required)
1415
```
1516

1617
---
@@ -317,3 +318,53 @@ dotnet add package [package-name]
317318
````
318319

319320
Check [this page](https://exercism.org/docs/tracks/fsharp/tests) to see what this looks like when rendered.
321+
322+
## File: `config.json`
323+
324+
**Purpose:** Tell the website what pages are available.
325+
326+
**Displayed on:** (not displayed)
327+
328+
### Example
329+
330+
```json
331+
{
332+
"docs": [
333+
{
334+
"uuid": "410d95ba-6294-4f40-af4a-6bb052977a3e",
335+
"slug": "installation",
336+
"path": "docs/INSTALLATION.md",
337+
"title": "Installing F# locally",
338+
"blurb": "Learn how to install F# locally to solve Exercism's exercises on your own machine"
339+
},
340+
{
341+
"uuid": "e0862775-d757-4d21-826f-b7cc2640ae8f",
342+
"slug": "learning",
343+
"path": "docs/LEARNING.md",
344+
"title": "How to learn F#",
345+
"blurb": "An overview of how to get started from scratch with F#"
346+
},
347+
{
348+
"uuid": "bca11b18-be81-468a-a34e-f5e6ac16bfd6",
349+
"slug": "tests",
350+
"path": "docs/TESTS.md",
351+
"title": "Testing on the F# track",
352+
"blurb": "Learn how to test your F# exercises on Exercism"
353+
},
354+
{
355+
"uuid": "39a578fe-e4ae-479e-b648-733882e244ef",
356+
"slug": "resources",
357+
"path": "docs/RESOURCES.md",
358+
"title": "Useful F# resources",
359+
"blurb": "A collection of useful resources to help you master F#"
360+
},
361+
{
362+
"uuid": "edfbb0fa-a950-4384-899f-6c6c7a440dca",
363+
"slug": "representer-normalizations",
364+
"path": "docs/REPRESENTER_NORMALIZATIONS.md",
365+
"title": "F# representer normalizations",
366+
"blurb": "An overview of the normalizations the F# representer applies to solutions"
367+
}
368+
]
369+
}
370+
```

0 commit comments

Comments
 (0)