

<!DOCTYPE html>

<html lang="en-US">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=Edge">

  <link rel="stylesheet" href="/assets/css/just-the-docs-default.css">

  <link rel="stylesheet" href="/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet">

  <style id="jtd-nav-activation">
  
    .site-nav ul li a {
      background-image: none;
    }

  </style>

  

  
    <script src="/assets/js/vendor/lunr.min.js"></script>
  

  <script src="/assets/js/just-the-docs.js"></script>

  <meta name="viewport" content="width=device-width, initial-scale=1">

  <link
  rel="icon"
  href="data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32'><rect width='32' height='32' rx='7' fill='%232563eb'/><text x='16' y='23' font-family='-apple-system,Segoe UI,Helvetica,Arial,sans-serif' font-size='19' font-weight='700' fill='%23fff' text-anchor='middle'>C</text></svg>"
/>


  <!-- Begin Jekyll SEO tag v2.9.0 -->
<title>CS30 Docs | Documentation for the CS30 coding-lab platform</title>
<meta name="generator" content="Jekyll v4.4.1" />
<meta property="og:title" content="CS30 Docs" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="Documentation for the CS30 coding-lab platform" />
<meta name="twitter:description" property="og:description" content="Documentation for the CS30 coding-lab platform" />
<link rel="canonical" href="https://cs30.app/assets/css/just-the-docs-head-nav.css" />
<meta property="og:url" content="https://cs30.app/assets/css/just-the-docs-head-nav.css" />
<meta property="og:site_name" content="CS30 Docs" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary" />
<meta name="twitter:title" content="CS30 Docs" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","description":"Documentation for the CS30 coding-lab platform","headline":"CS30 Docs","url":"https://cs30.app/assets/css/just-the-docs-head-nav.css"}</script>
<!-- End Jekyll SEO tag -->


  <script>
  (function () {
    // just-the-docs.js is a synchronous <script src> earlier in <head>, so jtd is
    // normally defined by now; guard anyway so a failed asset load degrades to the
    // light scheme instead of throwing before first paint.
    if (typeof jtd === 'undefined') return;
    var saved = null;
    try {
      saved = localStorage.getItem('cs30-theme');
    } catch (e) {
      /* private mode / storage disabled — fall through to the OS preference */
    }
    var prefersDark =
      window.matchMedia &&
      window.matchMedia('(prefers-color-scheme: dark)').matches;
    if (saved === 'dark' || (saved === null && prefersDark)) {
      jtd.setTheme('cs30dark');
    }
  })();
</script>


</head>

<body>
  <a class="skip-to-main" href="#main-content">Skip to main content</a>
  <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
  <symbol id="svg-link" viewBox="0 0 24 24">
  <title>Link</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link">
    <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
  </svg>
</symbol>

  <symbol id="svg-menu" viewBox="0 0 24 24">
  <title>Menu</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu">
    <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line>
  </svg>
</symbol>

  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
  <title>Expand</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right">
    <polyline points="9 18 15 12 9 6"></polyline>
  </svg>
</symbol>

  <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE -->
<symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link">
  <title id="svg-external-link-title">(external link)</title>
  <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line>
</symbol>

  
    <symbol id="svg-doc" viewBox="0 0 24 24">
  <title>Document</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file">
    <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline>
  </svg>
</symbol>

    <symbol id="svg-search" viewBox="0 0 24 24">
  <title>Search</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search">
    <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line>
  </svg>
</symbol>

  
  
    <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md -->
<symbol id="svg-copy" viewBox="0 0 16 16">
  <title>Copy</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16">
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/>
    <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/>
  </svg>
</symbol>
<symbol id="svg-copied" viewBox="0 0 16 16">
  <title>Copied</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16">
    <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/>
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/>
  </svg>
</symbol>

  
</svg>

  
    <header class="side-bar">
  <div class="site-header">
    <a href="/" class="site-title lh-tight">
  CS30 Docs

</a>
    <button id="menu-button" class="site-button btn-reset" aria-label="Menu" aria-expanded="false">
      <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg>
    </button>
  </div>

  <nav aria-label="Main" id="site-nav" class="site-nav">
  
  
    <ul class="nav-list"><li class="nav-list-item"><a href="/" class="nav-list-link">Home</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Internal submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/internal/" class="nav-list-link">Internal</a><ul class="nav-list"><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Architecture submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/internal/architecture/" class="nav-list-link">Architecture</a><ul class="nav-list"><li class="nav-list-item"><a href="/internal/architecture/overview/" class="nav-list-link">Overview</a></li><li class="nav-list-item"><a href="/internal/architecture/components/" class="nav-list-link">Components</a></li><li class="nav-list-item"><a href="/internal/architecture/data-flow/" class="nav-list-link">Data flow</a></li><li class="nav-list-item"><a href="/internal/architecture/data-model/" class="nav-list-link">Data model</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Deployment submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/internal/deployment/" class="nav-list-link">Deployment</a><ul class="nav-list"><li class="nav-list-item"><a href="/internal/deployment/overview/" class="nav-list-link">Overview</a></li><li class="nav-list-item"><a href="/internal/deployment/runbook/" class="nav-list-link">Runbook</a></li><li class="nav-list-item"><a href="/internal/deployment/configuration/" class="nav-list-link">Configuration</a></li></ul></li><li class="nav-list-item"><a href="/internal/cicd/" class="nav-list-link">CI/CD</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Development submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/internal/development/" class="nav-list-link">Development</a><ul class="nav-list"><li class="nav-list-item"><a href="/internal/development/setup/" class="nav-list-link">Local setup</a></li><li class="nav-list-item"><a href="/internal/development/workflow/" class="nav-list-link">Workflow</a></li><li class="nav-list-item"><a href="/internal/development/testing/" class="nav-list-link">Testing</a></li></ul></li><li class="nav-list-item"><a href="/internal/api/" class="nav-list-link">Backend API reference</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="External submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/external/" class="nav-list-link">External</a><ul class="nav-list"><li class="nav-list-item"><a href="/external/getting-started/" class="nav-list-link">Getting started</a></li><li class="nav-list-item"><a href="/external/usage/" class="nav-list-link">Setting up a course</a></li><li class="nav-list-item"><a href="/external/cli-reference/" class="nav-list-link">Command reference</a></li><li class="nav-list-item"><a href="/external/architecture/" class="nav-list-link">Architecture</a></li><li class="nav-list-item"><a href="/external/contributing/" class="nav-list-link">Contributing</a></li></ul></li></ul>
  
</nav>


<div class="d-md-block d-none site-footer">
  
  
    This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
  
  </div>
</header>

  
  <div class="main" id="top">
    <div id="main-header" class="main-header">
  
    

<div class="search" role="search">
  <div class="search-input-wrap">
    <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search CS30 Docs" autocomplete="off">
    <label for="search-input" class="search-label">
      <span class="sr-only">Search CS30 Docs</span>
      <svg viewBox="0 0 24 24" class="search-icon" aria-hidden="true"><use xlink:href="#svg-search"></use></svg>
    </label>
  </div>
  <div id="search-results" class="search-results"></div>
</div>

  
  <button
  class="theme-toggle"
  type="button"
  title="Toggle light and dark mode"
>
  <svg viewBox="0 0 24 24" aria-hidden="true" class="theme-toggle-icon">
    <path d="M12 2.5a1 1 0 0 1 1 1V5a1 1 0 0 1-2 0V3.5a1 1 0 0 1 1-1Zm0 14a4.5 4.5 0 1 1 0-9 4.5 4.5 0 0 1 0 9Zm0-2a2.5 2.5 0 1 0 0-5 2.5 2.5 0 0 0 0 5Zm0 3a1 1 0 0 1 1 1v1.5a1 1 0 0 1-2 0V18.5a1 1 0 0 1 1-1Zm8-5.5a1 1 0 0 1-1 1h-1.5a1 1 0 0 1 0-2H19a1 1 0 0 1 1 1Zm-13.5 0a1 1 0 0 1-1 1H4a1 1 0 0 1 0-2h1.5a1 1 0 0 1 1 1Zm11-6.36a1 1 0 0 1 0 1.41l-1.06 1.06a1 1 0 1 1-1.42-1.41l1.07-1.06a1 1 0 0 1 1.41 0ZM8 15.06a1 1 0 0 1 0 1.41l-1.06 1.06a1 1 0 0 1-1.41-1.41L6.6 15.06A1 1 0 0 1 8 15.06Zm9.94 2.47a1 1 0 0 1-1.41 0l-1.07-1.06A1 1 0 0 1 16.88 15l1.06 1.07a1 1 0 0 1 0 1.41ZM8 8.94a1 1 0 0 1-1.41 0L5.53 7.88a1 1 0 0 1 1.41-1.41L8 7.53A1 1 0 0 1 8 8.94Z"/>
  </svg>
  <span class="theme-toggle-label">Dark</span>
</button>

<script>
  jtd.onReady(function () {
    var btn = document.querySelector('.theme-toggle');
    if (!btn) return;
    var label = btn.querySelector('.theme-toggle-label');

    function isDark() {
      return jtd.getTheme() === 'cs30dark';
    }

    // The button offers the scheme you'd switch *to*.
    function render() {
      var next = isDark() ? 'light' : 'dark';
      label.textContent = next === 'dark' ? 'Dark' : 'Light';
      btn.setAttribute('aria-label', 'Switch to ' + next + ' mode');
    }

    jtd.addEvent(btn, 'click', function () {
      var next = !isDark();
      jtd.setTheme(next ? 'cs30dark' : 'cs30light');
      try {
        localStorage.setItem('cs30-theme', next ? 'dark' : 'light');
      } catch (e) {
        /* preference just won't persist */
      }
      render();

      // Mermaid renders each diagram once, into an SVG with baked-in colours, so
      // swapping the stylesheet cannot restyle it. Reload to re-render at the new
      // theme — only on pages that actually have a diagram.
      if (document.querySelector('.language-mermaid, .mermaid')) {
        window.location.reload();
      }
    });

    render();
  });
</script>

  
    <nav aria-label="Auxiliary" class="aux-nav">
  <ul class="aux-nav-list">
    
      <li class="aux-nav-list-item">
        <a href="https://github.com/SJSU-CS-systems-group/cs30" class="site-button"
          
          target="_blank" rel="noopener noreferrer"
          
        >
          GitHub
        </a>
      </li>
    
  </ul>
</nav>

  
</div>

    <div class="main-content-wrap">
      
      <div id="main-content" class="main-content">
        <main>
          
            <h.site-nav ul li a {
  background-image: linear-gradient(-90deg, #f1f5f9 0%, rgba(241, 245, 249, 0.8) 80%, rgba(241, 245, 249, 0) 100%);
}

          

          
            
          
        </main>
        
<hr>
<footer>
  
    <p><a href="#top" id="back-to-top">Back to top</a></p>
  

  

  
    <div class="d-flex mt-2">
      
      
        <p class="text-small mb-0">
          <a href="https://github.com/SJSU-CS-systems-group/cs30/edit/main/docs/assets/css/just-the-docs-head-nav.css" id="edit-this-page">Edit this page on GitHub</a>
        </p>
      
    </div>
  <div class="d-md-none mt-4 fs-2">
    
    
      This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
    
  </div>
</footer>

      </div>
    </div>
    
      

<div class="search-overlay"></div>

    
  </div>

  
    





<script type="module">
  
  import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@10.9.1/dist/mermaid.esm.min.mjs';
  

  var config = (function () {
  var link = document.querySelector('[rel="stylesheet"]');
  var isDark = !!link && link.getAttribute('href').indexOf('cs30dark') !== -1;
  return {
    theme: isDark ? 'dark' : 'neutral',
    darkMode: isDark,
    fontFamily:
      '-apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif',
    flowchart: { useMaxWidth: true, htmlLabels: true, curve: 'basis' },
    sequence: { useMaxWidth: true },
    er: { useMaxWidth: true },
    themeVariables: isDark
      ? {
          background: '#0f172a',
          primaryColor: '#1e293b',
          primaryTextColor: '#e2e8f0',
          primaryBorderColor: '#3b82f6',
          lineColor: '#64748b',
          secondaryColor: '#141f38',
          tertiaryColor: '#0b1220',
          // Subgraph boxes default to a mid-grey that glares on a dark page.
          clusterBkg: '#0b1220',
          clusterBorder: '#334155',
          titleColor: '#94a3b8',
          edgeLabelBackground: '#0f172a'
        }
      : {
          primaryColor: '#eff6ff',
          primaryTextColor: '#0f172a',
          primaryBorderColor: '#2563eb',
          lineColor: '#64748b',
          clusterBkg: '#f8fafc',
          clusterBorder: '#e2e8f0',
          titleColor: '#475569',
          edgeLabelBackground: '#ffffff'
        }
  };
})()
;
  mermaid.initialize(config);
  mermaid.run({
    querySelector: '.language-mermaid',
  });
</script>



  
</body>
</html>

