Skip to content

Commit bfa039d

Browse files
committed
Add template in readme
Signed-off-by: Raunak Madan <madanraunak24@gmail.com>
1 parent 025024f commit bfa039d

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,36 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
101101

102102
---
103103

104+
## Assessment Authoring
105+
106+
Assessment files use the Academy test layout and define their questions in Markdown frontmatter. Use short, stable IDs for assessments, questions, and options; question IDs must be unique within one assessment, and option IDs must be unique within one question. The Academy theme converts these author-facing IDs into deterministic UUIDs in the generated JSON consumed by Layer5 Cloud.
107+
108+
```yaml
109+
---
110+
title: "Assessment Example"
111+
id: "assessment-example"
112+
type: "test"
113+
layout: "test"
114+
passPercentage: 70
115+
maxAttempts: 3
116+
timeLimit: 30
117+
numberOfQuestions: 1
118+
questions:
119+
- id: "q1"
120+
text: "Layer5 Academy assessment files are authored in Markdown."
121+
type: "true-false"
122+
marks: 1
123+
options:
124+
- id: "true"
125+
text: "True"
126+
isCorrect: true
127+
- id: "false"
128+
text: "False"
129+
---
130+
```
131+
132+
---
133+
104134
## Publishing
105135

106136
- **Official content**: Merged changes are automatically integrated into the central academy-build pipeline and deployed to the Academy platform.

0 commit comments

Comments
 (0)