Syllabi: Revert generating a markdown file with the syllabi for each tutorial as we don't really need it.

Author: brycelelbach

.github/workflows/generate-syllabi-docker-compose.yml

@@ -35,6 +35,5 @@ jobs:
         run: |
           git checkout -B generated
           git add tutorials/**/notebooks/syllabi/*__docker_compose.yml
-          git add tutorials/**/notebooks/syllabi/syllabi.md
-          git commit -m "[Automated] Generate Docker compose files and syllabi.md from syllabi."
+          git commit -m "[Automated] Generate Docker compose files from syllabi."
           git push origin generated --force

brev/process-syllabi-docker-compose.py

@@ -6,12 +6,10 @@
 1. Copies the corresponding tutorials/*/brev/docker-compose.yml file
 2. Modifies it by setting the default-jupyter-url to the syllabus file path
 3. Outputs the modified file to tutorials/*/notebooks/syllabi/{syllabus-name}__docker_compose.yml
-4. Creates a syllabi.md file linking to all syllabi and their docker-compose files
 """
 
 import re
 from pathlib import Path
-from typing import List, Tuple
 
 
 def extract_working_dir(content: str) -> str:
@@ -54,34 +52,6 @@ def modify_docker_compose(content: str, jupyter_url: str) -> str:
     return modified
 
 
-def generate_syllabi_markdown(tutorial_name: str, syllabi_info: List[Tuple[str, str]]) -> str:
-    """
-    Generate a markdown file content listing all syllabi and their docker-compose files.
-
-    Args:
-        tutorial_name: Name of the tutorial
-        syllabi_info: List of tuples (syllabus_filename, docker_compose_filename)
-
-    Returns:
-        Generated markdown content
-    """
-    lines = [
-        f"# {tutorial_name.replace('-', ' ').title()} - Syllabi\n",
-        "\nThis directory contains different syllabi for this tutorial. Each syllabus is described in a notebook and has an associated Docker Compose configuration file that can be used to create a Brev Launchable.\n",
-        "\n## Available Syllabi\n"
-    ]
-
-    for syllabus_file, docker_compose_file in sorted(syllabi_info):
-        # Create a human-readable title from the filename
-        title = syllabus_file.replace('.ipynb', '').replace('_', ' ').replace('  ', ' - ')
-
-        lines.append(f"\n### {title}\n")
-        lines.append(f"- **Notebook**: [{syllabus_file}]({syllabus_file})\n")
-        lines.append(f"- **Docker Compose**: [{docker_compose_file}]({docker_compose_file})\n")
-
-    return ''.join(lines)
-
-
 def main():
     """Main processing function."""
     # Find all tutorials directories
@@ -121,9 +91,6 @@ def main():
             print(f"⚠️  Warning: Could not extract working-dir from {docker_compose_src}")
             continue
 
-        # Track syllabi info for generating the markdown file
-        syllabi_info = []
-
         # Process each syllabus file
         for syllabus_file in syllabi_dir.glob('*.ipynb'):
             # JupyterLab requires the "lab/tree/" prefix to open notebooks
@@ -139,24 +106,12 @@ def main():
             # Write modified docker-compose file next to the syllabus file
             # Pattern: /path/to/X.ipynb -> /path/to/X__docker_compose.yml
             syllabus_name = syllabus_file.stem # Filename without extension
-            docker_compose_filename = f"{syllabus_name}__docker_compose.yml"
-            output_file = syllabi_dir / docker_compose_filename
+            output_file = syllabi_dir / f"{syllabus_name}__docker_compose.yml"
             with open(output_file, 'w') as f:
                 f.write(modified_content)
 
-            # Track this syllabus for the markdown file
-            syllabi_info.append((syllabus_file.name, docker_compose_filename))
-
             processed_count += 1
 
-        # Generate syllabi.md file if there are any syllabi
-        if syllabi_info:
-            markdown_content = generate_syllabi_markdown(tutorial_name, syllabi_info)
-            markdown_file = syllabi_dir / 'syllabi.md'
-            with open(markdown_file, 'w') as f:
-                f.write(markdown_content)
-            print(f"  📝 Generated: syllabi.md")
-
     print(f"\n✅ Successfully processed {processed_count} syllabi files")
 
     return 0