Skip to content

Commit a3ec7e9

Browse files
committed
guides hub audit, six fixes. (1) hero "Field manual · 14 recipes" → "15 recipes" — accurate count after the three additions (clonal-families, trace-introspection, with-metadata) and two deletions (custom-pass, custom-shm) in the earlier passes. (2) filter chip counts were all out of date — corrected to All=15, Build=3, Validate=4, Customize=4, Operate=4 to match the actual cards on the page. (3) trace-introspection card was still using the stale mutate.s5f.pos[42] address that we fixed everywhere else — now mutate.s5f.site[42], matching the real engine trace addressing (verified via trace.find('mutate.s5f.pos[0]') returning None vs mutate.s5f.site[0] returning the real ChoiceRecord). (4) export card claimed "AIRR TSV, Parquet, or FASTA" but SimulationResult has no to_parquet() method — verified the actual writer set is to_csv/to_tsv/to_fasta/to_fastq/to_dataframe — so the card now lists the real options ("AIRR TSV, FASTA, FASTQ, or pandas"). (5) reproduce card claimed "recreating the figure-2 dataset from the GenAIRR paper" but the actual guide-reproduce.html is a generic reproducibility-pattern recipe with a placeholder example header reading 'Title of My Paper (Author et al., 2026)' — not a paper-specific walkthrough. card now honestly describes what the guide delivers: pin every input (seed/config/contracts), hash the output, ship the recipe alongside the data. (6) footer was using <footer class="footer"> with the inconsistent shorter shape, missing the License + AIRR-fields links — swapped to standard <footer class="foot"> with all three Project column links restored, matching the rest of the site.
1 parent a7bae5f commit a3ec7e9

1 file changed

Lines changed: 26 additions & 21 deletions

File tree

website/guides.html

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535

3636
<div class="gh-grid">
3737
<div class="gh-text">
38-
<span class="eyebrow">Field manual · 14 recipes</span>
38+
<span class="eyebrow">Field manual · 15 recipes</span>
3939
<h1>Guides.</h1>
4040
<p class="lead">
4141
Short, task-oriented recipes. Each one starts with an outcome and ends with a
@@ -63,11 +63,11 @@ <h1>Guides.</h1>
6363
<div class="gf-bar">
6464
<div class="gf-group">
6565
<span class="gf-label">Filter</span>
66-
<button class="gf-chip gf-chip-on">All <span class="gf-chip-n">14</span></button>
67-
<button class="gf-chip">Build <span class="gf-chip-n">4</span></button>
66+
<button class="gf-chip gf-chip-on">All <span class="gf-chip-n">15</span></button>
67+
<button class="gf-chip">Build <span class="gf-chip-n">3</span></button>
6868
<button class="gf-chip">Validate <span class="gf-chip-n">4</span></button>
69-
<button class="gf-chip">Customize <span class="gf-chip-n">3</span></button>
70-
<button class="gf-chip">Operate <span class="gf-chip-n">3</span></button>
69+
<button class="gf-chip">Customize <span class="gf-chip-n">4</span></button>
70+
<button class="gf-chip">Operate <span class="gf-chip-n">4</span></button>
7171
</div>
7272
<div class="gf-search">
7373
<span class="gf-search-icon"></span>
@@ -281,7 +281,7 @@ <h3>Replay a simulation with one knob changed.</h3>
281281
<div class="gc-body">
282282
<h3>Introspect the trace.</h3>
283283
<p>Every random draw the engine makes is addressable: <code>sample_allele.v</code>,
284-
<code>np.np1.bases[3]</code>, <code>mutate.s5f.pos[42]</code>. Query by name, by
284+
<code>np.np1.bases[3]</code>, <code>mutate.s5f.site[42]</code>. Query by name, by
285285
prefix, or count draws per pass to audit what the engine actually did.</p>
286286
<div class="gc-meta">
287287
<span class="gc-time">~10 min</span>
@@ -309,7 +309,7 @@ <h2>Operate.</h2>
309309
<a class="gc" href="guide-export.html">
310310
<div class="gc-num">D·01</div>
311311
<div class="gc-body">
312-
<h3>Export to AIRR TSV, Parquet, or FASTA.</h3>
312+
<h3>Export to AIRR TSV, FASTA, FASTQ, or pandas.</h3>
313313
<p>Each writer in one line. When to pick which. How to keep the
314314
<code>truth_*</code> fields versus stripping them for a blinded benchmark.</p>
315315
<div class="gc-meta">
@@ -342,8 +342,8 @@ <h3>Stream millions of sequences without OOM.</h3>
342342
<div class="gc-num">D·03</div>
343343
<div class="gc-body">
344344
<h3>Reproduce a published dataset.</h3>
345-
<p>Walk-through of recreating the figure-2 dataset from the GenAIRR paper —
346-
every seed, every config, every plot. Bring your own GPU not required.</p>
345+
<p>Pin every input (seed, config, contracts), hash the output, and ship the recipe
346+
alongside the data so anyone — including future you — can rebuild it bit-for-bit.</p>
347347
<div class="gc-meta">
348348
<span class="gc-time">~45 min</span>
349349
<span class="gc-dot">·</span>
@@ -393,28 +393,33 @@ <h2>Tell us what you tried to do.</h2>
393393
</div>
394394
</section>
395395

396-
<footer class="footer">
397-
<div class="footer-inner">
398-
<div>
399-
<div class="brand"><span class="brand-mark">G</span><span>GenAIRR</span></div>
400-
<p class="footer-tag">Synthetic AIRR with ground truth.</p>
396+
<footer class="foot">
397+
<div class="foot-inner">
398+
<div class="foot-l">
399+
<div class="brand foot-brand">
400+
<span class="brand-mark">G</span>
401+
<span>GenAIRR</span>
402+
</div>
403+
<div class="foot-tag">Ground-truth AIRR simulation.</div>
401404
</div>
402-
<div class="footer-cols">
403-
<div>
404-
<h4>Learn</h4>
405+
<div class="foot-cols">
406+
<div class="foot-col">
407+
<div class="foot-head">Learn</div>
405408
<a href="learn.html">Tutorial</a>
406409
<a href="concepts.html">Concepts</a>
407410
<a href="guides.html">Guides</a>
408411
</div>
409-
<div>
410-
<h4>Reference</h4>
412+
<div class="foot-col">
413+
<div class="foot-head">Reference</div>
411414
<a href="reference.html">Python API</a>
412415
<a href="reference.html#configs">Configs</a>
416+
<a href="reference.html#airr">AIRR fields</a>
413417
</div>
414-
<div>
415-
<h4>Project</h4>
418+
<div class="foot-col">
419+
<div class="foot-head">Project</div>
416420
<a href="https://github.com/MuteJester/GenAIRR">GitHub</a>
417421
<a href="https://doi.org/10.1093/bib/bbae556">Cite</a>
422+
<a href="https://github.com/MuteJester/GenAIRR/blob/master/LICENSE">License</a>
418423
</div>
419424
</div>
420425
</div>

0 commit comments

Comments
 (0)