Skip to content

Commit ec740c3

Browse files
committed
fix links, wrap
Signed-off-by: Robert Detjens <github@detjens.dev>
1 parent 471e1f5 commit ec740c3

File tree

2 files changed

+32
-10
lines changed

2 files changed

+32
-10
lines changed

docs/.vitepress/config.mts

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,31 @@ export default defineConfig({
1010
nav: [
1111
{ text: "Setup", link: "guides/infra-quickstart" },
1212
{
13-
text: "Config Reference",
14-
link: "reference/rcds-yaml-reference",
13+
text: "Guides",
14+
items: [
15+
{ text: "Deployment Quickstart", link: "for-sysadmins/quickstart" },
16+
{ text: "Add new challenge", link: "for-authors/quickstart" },
17+
],
18+
},
19+
20+
{
21+
text: "Infrastructure Setup",
22+
items: [
23+
{ text: "Quickstart", link: "/for-sysadmins/quickstart" },
24+
{ text: "Install", link: "/for-sysadmins/install" },
25+
{ text: "Config Reference", link: "/for-sysadmins/config" },
26+
{ text: "Architecture", link: "/for-sysadmins/architecture" },
27+
],
1528
},
1629
{
17-
text: "Challenge Reference",
18-
link: "reference/challenge-yaml-reference",
30+
text: "Challenge Authors",
31+
items: [
32+
{ text: "Challenge Quickstart", link: "/for-authors/quickstart" },
33+
{
34+
text: "Challenge Config Reference",
35+
link: "/for-authors/challenge-config",
36+
},
37+
],
1938
},
2039
],
2140

docs/reference/challenge-yaml-reference.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,13 @@ Available fields:
1919
- type: `string`
2020
- no default
2121

22-
The name of the challenge, as shown to players in the frontend UI.
22+
The name of the challenge, as shown to players in the frontend UI. Any
23+
characters are allowed.
2324

2425
```yaml
2526
name: notsh
26-
27-
# can have spaces:
27+
name: cha-cha-cha
28+
# name can have spaces:
2829
name: Revenge of the FIPS
2930
```
3031
@@ -33,11 +34,11 @@ name: Revenge of the FIPS
3334
- type: `string`
3435
- no default
3536

36-
Author or authors of the challenge, as shown to players in the frontend UI. If there are multiple authors, specify them as one string.
37+
Author or authors of the challenge, as shown to players in the frontend UI. If
38+
there are multiple authors, specify them as one string.
3739

3840
```yaml
3941
author: John Author
40-
4142
# multiple authors:
4243
author: Alice, Bob, and others
4344
```
@@ -47,7 +48,9 @@ author: Alice, Bob, and others
4748
- type: `string`
4849
- no default
4950

50-
Description and flavortext for the challenge, as shown to players in the frontend UI. Supports templating to include information about the challenge, such as the link or command to connect.
51+
Description and flavortext for the challenge, as shown to players in the
52+
frontend UI. Supports templating to include information about the challenge,
53+
such as the link or command to connect.
5154

5255
Most challenges only need `{{ nc }}` or `{{ link }}`.
5356

0 commit comments

Comments
 (0)