docs/index.html at main · mued-api/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1" />
  <title>µEd API</title>
  <style>
    body { font-family: system-ui, sans-serif; max-width: 800px; margin: 0 auto; padding: 2rem; color: #1f2328; }
    h1 { font-size: 2rem; margin-bottom: 0.5rem; }
    .subtitle { color: #57606a; margin-top: 0; }
    .cta { display: inline-block; margin: 1.5rem 0; padding: 0.75rem 1.5rem;
           background: #0969da; color: #fff; text-decoration: none; border-radius: 6px;
           font-weight: 500; }
    .cta:hover { background: #0860ca; }
    .links { display: flex; gap: 1rem; flex-wrap: wrap; align-items: center; margin-top: 0.5rem; }
    .links a { color: #0969da; text-decoration: none; font-size: 0.9rem; }
    .links a:hover { text-decoration: underline; }
    .release { border-top: 1px solid #d0d7de; padding: 1.5rem 0; }
    .release h3 { margin: 0 0 0.25rem; font-size: 1.1rem; }
    .release time { font-size: 0.85rem; color: #57606a; }
    .release-body { margin-top: 0.75rem; line-height: 1.6; }
    .release-body p { margin: 0.5rem 0; }
    .release-body ul { margin: 0.5rem 0; padding-left: 1.5rem; }
    .citation { background: #f6f8fa; border: 1px solid #d0d7de; border-radius: 6px;
                padding: 1rem 1.25rem; font-size: 0.9rem; line-height: 1.6; margin-top: 0.75rem; }
    .citation a { color: #0969da; text-decoration: none; }
    .citation a:hover { text-decoration: underline; }
  </style>
</head>
<body>
  <h1>µEd API</h1>
  <p class="subtitle">A standard interface for education microservices</p>
  <p>The µEd API (pronounced mew-ed) defines a common contract for services providing automatic feedback,
     grading, and conversational learning endpoints.</p>

  <a class="cta" href="./spec/">View API Documentation</a>

  <div class="links">
    <a href="https://github.com/mued-api/muEd-api">GitHub Repository</a>
    <a href="./openapi.yml">openapi.yml</a>
    <a href="https://forms.office.com/e/1DB82p3AJE">Express your interest in getting involved!</a>
  </div>

  <h2>Citation</h2>
  <p>To learn more about µEd API, please cite our paper:</p>
  <div class="citation">
    Maximilian Sölch, Alexandra Neagu, Marcus Messer, Peter B. Johnson, Gerd Kortemeyer, Samuel S. H. Ng,
    Fun Siong Lim, and Stephan Krusche. 2026. µEd API: Towards a Shared API for Education Microservices.
    In <em>Proceedings of the Thirteenth ACM Conference on Learning @ Scale (L@S '26)</em>.
    Association for Computing Machinery, New York, NY, USA, 520–524.
    <a href="https://doi.org/10.1145/3774398.3811592">https://doi.org/10.1145/3774398.3811592</a>
  </div>

  <h2>Changelog</h2>
  <div id="changelog"><p>Loading...</p></div>

  <script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
  <script>
    fetch('./changelog.json')
      .then(r => r.json())
      .then(releases => {
        const el = document.getElementById('changelog');
        if (!releases.length) { el.innerHTML = '<p>No releases yet.</p>'; return; }
        el.innerHTML = releases.map(r => `
          <div class="release">
            <h3>${r.name || r.tag_name}</h3>
            <time>${new Date(r.published_at).toLocaleDateString('en-GB', { year: 'numeric', month: 'long', day: 'numeric' })}</time>
            <div class="release-body">${marked.parse(r.body || '')}</div>
          </div>`).join('');
      })
      .catch(() => {
        document.getElementById('changelog').innerHTML = '<p>Changelog unavailable.</p>';
      });
  </script>
</body>
</html>