Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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
Expand Down
12 changes: 7 additions & 5 deletions WORKFLOW_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -55,16 +56,17 @@ 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

### 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")
Expand Down
4 changes: 2 additions & 2 deletions examples/course.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading