From ea5680d1d2d52736fcb54f8971d31843293a419a Mon Sep 17 00:00:00 2001 From: rryoung98 Date: Fri, 5 Jun 2026 08:05:18 -0500 Subject: [PATCH] docs: fix imageLink to be repo paths, add chapterFileName imageLink.darkLogo/lightLogo are repo-relative paths to image files (as used in real courses), not external URLs. Update WORKFLOW_GUIDE.md, AGENTS.md, and examples/course.json accordingly. Also document chapterFileName, a field required by the validator and present in every real course.json but previously omitted from the docs. Co-Authored-By: Claude Opus 4.8 --- AGENTS.md | 6 ++++-- WORKFLOW_GUIDE.md | 12 +++++++----- examples/course.json | 4 ++-- 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 9694ccc..b30b869 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -91,14 +91,15 @@ Agents should validate or generate `course.json` with the following structure: "courseDescription": "Course description", "visibility": "public", "imageLink": { - "darkLogo": "https://example.com/dark-logo.jpg", - "lightLogo": "https://example.com/light-logo.jpg" + "darkLogo": "assets/images/dark-logo.png", + "lightLogo": "assets/images/light-logo.png" }, "tags": ["tag1", "tag2"], "deployedTo": ["qbraid.com"], "content": [ { "chapterName": "Chapter Name", + "chapterFileName": "notebook.ipynb", "chapterNumber": 1, "baseFilePath": "./path/to/notebook.ipynb", "kernelName": "python3", @@ -113,6 +114,7 @@ Agents should validate or generate `course.json` with the following structure: - **Notebooks**: Must exist at paths specified in `course.json`, max 5MB each - **Images**: Referenced images must exist and be under 1MB +- **Logos**: `imageLink.darkLogo` and `imageLink.lightLogo` are repo-relative paths to image files (e.g. `assets/images/dark-logo.png`), not external URLs. Leave as empty strings (`""`) to use the platform default. - **Security**: Notebooks are scanned for XSS, script injection, and credential exposure ## Agent Workflow Steps diff --git a/WORKFLOW_GUIDE.md b/WORKFLOW_GUIDE.md index f1f358f..9f86bab 100644 --- a/WORKFLOW_GUIDE.md +++ b/WORKFLOW_GUIDE.md @@ -24,14 +24,15 @@ Your repository must contain a `course.json` file in the root with the following "courseDescription": "A beginner-friendly course on quantum computing fundamentals", "visibility": "public", "imageLink": { - "darkLogo": "https://example.com/dark-logo.jpg", - "lightLogo": "https://example.com/light-logo.jpg" + "darkLogo": "assets/images/dark-logo.png", + "lightLogo": "assets/images/light-logo.png" }, "tags": ["quantum computing", "beginner"], "deployedTo": ["qbraid.com"], "content": [ { "chapterName": "Introduction to Python", + "chapterFileName": "intro.ipynb", "chapterNumber": 1, "baseFilePath": "./chapter1/intro.ipynb", "kernelName": "python3", @@ -55,9 +56,9 @@ Your repository must contain a `course.json` file in the root with the following - **courseName** (string): Name of the course - **courseDescription** (string): Brief description of the course - **visibility** (string): Visibility setting (e.g., "public", "private") -- **imageLink** (object): Logo URLs for dark and light themes - - **darkLogo** (string): URL for dark theme logo - - **lightLogo** (string): URL for light theme logo +- **imageLink** (object): Logo image paths for dark and light themes + - **darkLogo** (string): Repo-relative path to the dark theme logo image (e.g. `assets/images/dark-logo.png`) + - **lightLogo** (string): Repo-relative path to the light theme logo image (e.g. `assets/images/light-logo.png`) - **tags** (array of strings): List of tags for the course - **deployedTo** (array of strings): Deployment targets (allowed: "qbraid.com", "quera.com") - **content** (array): List of chapters @@ -65,6 +66,7 @@ Your repository must contain a `course.json` file in the root with the following ### Chapter Fields - **chapterName** (string): Display name for the chapter +- **chapterFileName** (string): Notebook file name for the chapter (e.g. `intro.ipynb`) - **chapterNumber** (number): Chapter number/order - **baseFilePath** (string): Path to the chapter notebook from repo root (max 5MB) - **kernelName** (string): Jupyter kernel to use (e.g., "python3", "qbraid_python") diff --git a/examples/course.json b/examples/course.json index 4f0d840..4c6a344 100644 --- a/examples/course.json +++ b/examples/course.json @@ -3,8 +3,8 @@ "courseDescription": "A beginner-friendly course on the fundamentals of quantum computing, covering qubits, quantum gates, and basic algorithms.", "visibility": "public", "imageLink": { - "darkLogo": "https://img.freepik.com/free-vector/gradient-quantum-illustration_52683-80504.jpg", - "lightLogo": "https://img.freepik.com/free-vector/gradient-quantum-illustration_52683-80504.jpg" + "darkLogo": "assets/images/dark-logo.png", + "lightLogo": "assets/images/light-logo.png" }, "tags": [ "quantum computing",