Skip to content

Commit

Permalink
Document adding docs (#553)
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikSchierboom authored Aug 20, 2024
1 parent 5f4352e commit 361a016
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions building/tracks/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -368,3 +368,24 @@ Check [this page](https://exercism.org/docs/tracks/fsharp/tests) to see what thi
]
}
```

## Adding documents

It is possible to add additional documents should you so desire.
To do so, you need to do two things:

1. Create the document within the `docs` directory (e.g. `docs/PACKAGES.md`)
2. Add an entry to the `docs/config.json` file for the new document.
For example:

```json
{
"uuid": "6268fd29-55e2-44e6-afc2-f86671fe799f",
"slug": "packages",
"path": "docs/PACKAGES.md",
"title": "Supported packages",
"blurb": "List of the supported packages"
}
```

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 comments on commit 361a016

Please sign in to comment.