Skip to content

Commit efbb27f

Browse files
Document adding docs
1 parent 3d692cf commit efbb27f

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

building/tracks/docs.md

+21
Original file line numberDiff line numberDiff line change
@@ -368,3 +368,24 @@ Check [this page](https://exercism.org/docs/tracks/fsharp/tests) to see what thi
368368
]
369369
}
370370
```
371+
372+
## Adding documents
373+
374+
It is possible to add additional documents should you so desire.
375+
To do so, you need to do two things:
376+
377+
1. Create the document within the `docs` directory (e.g. `docs/PACKAGES.md`)
378+
2. Add an entry to the `docs/config.json` file for the new document.
379+
For example:
380+
381+
```json
382+
{
383+
"uuid": "6268fd29-55e2-44e6-afc2-f86671fe799f",
384+
"slug": "packages",
385+
"path": "docs/PACKAGES.md",
386+
"title": "Supported packages",
387+
"blurb": "List of the supported packages"
388+
}
389+
```
390+
391+
Once merged to `main`, the document can be found at `https://exercism.org/docs/tracks/<track_slug>/<document_slug>` (e.g. `https://exercism.org/docs/tracks/fsharp/packages`)

0 commit comments

Comments
 (0)