From 71017133a55053b4532b32fa8dacca2c9fe02d61 Mon Sep 17 00:00:00 2001
From: Rotimi Best <best@classroomio.com>
Date: Wed, 18 Dec 2024 05:17:57 +0100
Subject: [PATCH] docs: add page types in course-app README

---
 packages/course-app/README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/packages/course-app/README.md b/packages/course-app/README.md
index 48684bc6..b9fcaa58 100644
--- a/packages/course-app/README.md
+++ b/packages/course-app/README.md
@@ -166,7 +166,23 @@ Each page configuration includes:
    - Contains course-specific header and layout settings
    - Manages how courses are displayed and filtered
 
-Each section can be toggled with the `show` property and customized through its `settings` object.
+Each section can be toggled with the `show` property and customized through its `settings` object. Here is a breakdown of each page
+
+```ts
+type Page = {
+  id: string;
+  title: string;
+  slug: string;
+  status: 'draft' | 'published';
+  sections: Section[];
+};
+
+type Section = {
+  settings: Record<string, any>;
+  show: boolean;
+  type: string;
+};
+```
 
 ## API Routes