mirror of
https://github.com/dirtydishes/dreamio.git
synced 2026-06-06 21:38:15 +00:00
add turn doc template guidance
This commit is contained in:
parent
bbf6ae806b
commit
05bfbc0cd8
3 changed files with 337 additions and 5 deletions
319
docs/turns/template.html
Normal file
319
docs/turns/template.html
Normal file
|
|
@ -0,0 +1,319 @@
|
|||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title><!-- TITLE --></title>
|
||||
<link rel="preconnect" href="https://fonts.googleapis.com">
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||||
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@500;600&family=IBM+Plex+Sans:wght@400;500;600&family=Quantico:wght@400;700&display=swap" rel="stylesheet">
|
||||
<style>
|
||||
:root {
|
||||
color-scheme: dark;
|
||||
--bg: #06080b;
|
||||
--bg-2: #0b1016;
|
||||
--panel: rgba(17, 24, 32, 0.92);
|
||||
--panel-2: rgba(13, 20, 27, 0.94);
|
||||
--line: rgba(255, 255, 255, 0.1);
|
||||
--text: #e6edf4;
|
||||
--muted: #90a0b2;
|
||||
--faint: #6e7b8c;
|
||||
--lavender: #bda7ff;
|
||||
--lavender-soft: rgba(189, 167, 255, 0.16);
|
||||
--pink: #ff9bd2;
|
||||
--blue: #8bc1ff;
|
||||
--code: #0a0f14;
|
||||
--shadow: 0 24px 70px rgba(0, 0, 0, 0.45);
|
||||
--radius: 14px;
|
||||
}
|
||||
|
||||
* {
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
min-height: 100vh;
|
||||
background:
|
||||
radial-gradient(circle at top left, rgba(189, 167, 255, 0.18), transparent 32rem),
|
||||
radial-gradient(circle at top right, rgba(255, 155, 210, 0.12), transparent 26rem),
|
||||
linear-gradient(180deg, var(--bg) 0%, #081017 42%, #05080c 100%);
|
||||
color: var(--text);
|
||||
font-family: "IBM Plex Sans", system-ui, sans-serif;
|
||||
line-height: 1.6;
|
||||
}
|
||||
|
||||
main {
|
||||
width: min(1080px, calc(100% - 32px));
|
||||
margin: 0 auto;
|
||||
padding: 40px 0 64px;
|
||||
}
|
||||
|
||||
header,
|
||||
section {
|
||||
border: 1px solid var(--line);
|
||||
border-radius: var(--radius);
|
||||
background: linear-gradient(180deg, var(--panel), var(--panel-2));
|
||||
}
|
||||
|
||||
header {
|
||||
padding: 28px;
|
||||
border-radius: calc(var(--radius) + 2px);
|
||||
background: linear-gradient(180deg, rgba(17, 24, 32, 0.96), rgba(11, 16, 22, 0.94));
|
||||
box-shadow: var(--shadow);
|
||||
}
|
||||
|
||||
.eyebrow,
|
||||
h2,
|
||||
.meta-chip,
|
||||
.diff-title {
|
||||
font-family: "IBM Plex Mono", monospace;
|
||||
}
|
||||
|
||||
.eyebrow {
|
||||
margin: 0 0 12px;
|
||||
color: var(--lavender);
|
||||
font-size: 0.76rem;
|
||||
letter-spacing: 0.14em;
|
||||
text-transform: uppercase;
|
||||
}
|
||||
|
||||
h1 {
|
||||
margin: 0;
|
||||
max-width: 16ch;
|
||||
font-family: "Quantico", sans-serif;
|
||||
font-size: clamp(2.1rem, 4vw, 4.2rem);
|
||||
line-height: 1.04;
|
||||
letter-spacing: 0.06em;
|
||||
text-transform: uppercase;
|
||||
}
|
||||
|
||||
.summary {
|
||||
max-width: 72ch;
|
||||
margin: 18px 0 0;
|
||||
color: var(--muted);
|
||||
font-size: 1.02rem;
|
||||
}
|
||||
|
||||
.meta-row {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
gap: 10px;
|
||||
margin-top: 18px;
|
||||
}
|
||||
|
||||
.meta-chip {
|
||||
padding: 6px 10px;
|
||||
border: 1px solid rgba(189, 167, 255, 0.28);
|
||||
border-radius: 999px;
|
||||
background: rgba(189, 167, 255, 0.11);
|
||||
color: var(--text);
|
||||
font-size: 0.74rem;
|
||||
letter-spacing: 0.08em;
|
||||
text-transform: uppercase;
|
||||
}
|
||||
|
||||
.grid {
|
||||
display: grid;
|
||||
gap: 18px;
|
||||
margin-top: 20px;
|
||||
}
|
||||
|
||||
section {
|
||||
padding: 22px;
|
||||
}
|
||||
|
||||
h2 {
|
||||
margin: 0 0 12px;
|
||||
color: var(--lavender);
|
||||
font-size: 0.84rem;
|
||||
letter-spacing: 0.12em;
|
||||
text-transform: uppercase;
|
||||
}
|
||||
|
||||
p,
|
||||
li {
|
||||
max-width: 76ch;
|
||||
}
|
||||
|
||||
ul {
|
||||
margin: 0;
|
||||
padding-left: 1.15rem;
|
||||
}
|
||||
|
||||
li + li {
|
||||
margin-top: 8px;
|
||||
}
|
||||
|
||||
code,
|
||||
pre {
|
||||
font-family: "IBM Plex Mono", monospace;
|
||||
}
|
||||
|
||||
code {
|
||||
color: #decfff;
|
||||
}
|
||||
|
||||
.callout {
|
||||
padding: 14px 16px;
|
||||
border: 1px solid rgba(189, 167, 255, 0.2);
|
||||
border-radius: 12px;
|
||||
background: var(--lavender-soft);
|
||||
color: var(--text);
|
||||
}
|
||||
|
||||
.diff-grid {
|
||||
display: grid;
|
||||
gap: 18px;
|
||||
}
|
||||
|
||||
.diff-shell {
|
||||
border: 1px solid var(--line);
|
||||
border-radius: 12px;
|
||||
overflow: hidden;
|
||||
background: rgba(8, 12, 17, 0.92);
|
||||
}
|
||||
|
||||
.diff-title {
|
||||
margin: 0;
|
||||
padding: 12px 14px;
|
||||
border-bottom: 1px solid var(--line);
|
||||
color: var(--text);
|
||||
font-size: 0.76rem;
|
||||
letter-spacing: 0.08em;
|
||||
text-transform: uppercase;
|
||||
}
|
||||
|
||||
.diff-view {
|
||||
min-height: 84px;
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
.diff-view:empty {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.diff-fallback {
|
||||
margin: 0;
|
||||
padding: 16px;
|
||||
overflow-x: auto;
|
||||
background: var(--code);
|
||||
color: var(--text);
|
||||
font-size: 0.86rem;
|
||||
line-height: 1.5;
|
||||
}
|
||||
|
||||
.diff-shell.rendered .diff-fallback {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.note {
|
||||
margin-top: 12px;
|
||||
color: var(--faint);
|
||||
font-size: 0.9rem;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #8bc1ff;
|
||||
}
|
||||
|
||||
@media (max-width: 720px) {
|
||||
main {
|
||||
width: min(100%, calc(100% - 20px));
|
||||
padding: 18px 0 28px;
|
||||
}
|
||||
|
||||
header,
|
||||
section {
|
||||
padding: 18px;
|
||||
}
|
||||
|
||||
h1 {
|
||||
max-width: none;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<main>
|
||||
<header>
|
||||
<p class="eyebrow">Dreamio turn document</p>
|
||||
<h1><!-- TITLE --></h1>
|
||||
<p class="summary"><!-- SUMMARY --></p>
|
||||
<div class="meta-row">
|
||||
<!-- META_CHIPS -->
|
||||
<span class="meta-chip">YYYY-MM-DD</span>
|
||||
<span class="meta-chip">Beads issue dreamio-xxx</span>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<div class="grid">
|
||||
<section>
|
||||
<h2>Summary</h2>
|
||||
<p><!-- SUMMARY --></p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<h2>Changes Made</h2>
|
||||
<ul>
|
||||
<li><!-- CHANGE ITEM --></li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<h2>Context</h2>
|
||||
<p><!-- CONTEXT --></p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<h2>Important Implementation Details</h2>
|
||||
<ul>
|
||||
<li><!-- IMPLEMENTATION DETAIL --></li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<h2>Relevant Diff Snippets</h2>
|
||||
<div class="diff-grid">
|
||||
<!-- DIFF_SHELLS -->
|
||||
<div class="diff-shell rendered">
|
||||
<p class="diff-title">path/to/file.ext · short description</p>
|
||||
<div class="diff-view">
|
||||
<!-- Insert exactly one @pierre/diffs/ssr prerendered file diff here. -->
|
||||
</div>
|
||||
<pre class="diff-fallback"><code><!-- Plain fallback diff only if SSR rendering fails. --></code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<p class="note">Diffs are generated with <code>@pierre/diffs/ssr</code> at documentation time. Each file diff stays inside its own shell so the page remains readable as a static HTML artifact.</p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<h2>Expected Impact for End-Users</h2>
|
||||
<p><!-- EXPECTED IMPACT --></p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<h2>Validation</h2>
|
||||
<!-- VALIDATION -->
|
||||
<ul>
|
||||
<li><!-- VALIDATION ITEM --></li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<h2>Issues, Limitations, and Mitigations</h2>
|
||||
<ul>
|
||||
<li><!-- LIMITATION OR MITIGATION --></li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<h2>Follow-up Work</h2>
|
||||
<ul>
|
||||
<li><!-- FOLLOW-UP ITEM --></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue