Skip to content

docs: surface genotype + clonal on homepage & Choose-your-path (and fix dead learn page) - #11

Merged
MuteJester merged 4 commits into
masterfrom
docs-index-paths
Jun 18, 2026
Merged

docs: surface genotype + clonal on homepage & Choose-your-path (and fix dead learn page)#11
MuteJester merged 4 commits into
masterfrom
docs-index-paths

Conversation

@MuteJester

Copy link
Copy Markdown
Owner

Summary

Post-2.3.0 docs polish so the genotype suite (and clonal work) are discoverable from the landing pages, plus a fix for a pre-existing redirect bug that made the "Choose your path" page unreachable.

Docs-only.

Index page (index.md)

  • New "Genotype" capability card (7th) — per-individual diploid germline, phased V(D)J, zygosity/deletion/novel alleles, cohorts. Heading "Six → Seven capabilities"; themed via a new cap-genotype accent.
  • Benchmark feature card now calls out scoring genotype-inference tools (TIgGER, IgDiscover) against by-construction truth.
  • Choose-your-path table: added Simulate per-individual genotypes, Simulate clonal lineages & repertoires, and Benchmark tools against ground truth (5 → 8 paths).

Choose-your-path page (learn.md)

  • Added dedicated Genotype, Clonal, and Benchmark reader paths (clonal now has its own path instead of being buried under "understand biology mechanisms").

Fix: dead "Choose your path" page

  • The redirects plugin had "learn.md": "getting-started/index.md", which overwrote the built learn.html with a redirect stub — so the nav's "Choose your path" tab bounced to getting-started and learn.md's content never rendered at its URL. Removed that one entry; learn.html now serves the real (enhanced) page. All other redirect mappings are unchanged.

Test plan

  • mkdocs build clean (exit 0, no warnings/broken links).
  • index.html renders 7 capability cards + the 3 new path rows; Benchmark card updated.
  • learn.html is now the full page (55 KB) with all 8 paths (previously a 486-byte redirect stub).

- index: add a Genotype capability card (7th) + accent; tie genotype-inference
  benchmarking into the Benchmark feature card; add Genotype / Clonal / Benchmark
  rows to the Choose-your-path table
- learn: add dedicated Genotype, Clonal, and Benchmark reader paths (and give
  clonal its own path instead of being buried under the biology path)
- fix: drop the 'learn.md' -> getting-started redirect that was clobbering the
  built learn.html (the Choose-your-path page was unreachable)
…_allele API, stale audit-docs links, stale 'no frequency prior' line
…omise, disambiguate cartridge nav, trim homepage router to marquee paths, fix getting-started CTA, refresh stale mkdocs header
…mepage paths

- Convert guides/productive.md from migration stub into a full guide
  (productive triad, constrain-before-propose, SHM interaction, AIRR
  productive field, when to use) and add it to the nav.
- Repoint 6 live->stub links to live equivalents (pipeline concept ->
  Experiment builder / Core concepts; cartridge estimators -> Estimate
  models from data; v-subregion annotations -> Build a reference
  cartridge; tune-corruption -> corruption-sequencing; v-usage ->
  recombination-junction allele-universe; two-layer-model ->
  architecture two-layer section).
- Restore the reference-cartridge / validation / API homepage routes by
  expanding 'Choose your path' to six paths.
@MuteJester
MuteJester merged commit 9c2afd5 into master Jun 18, 2026
13 checks passed
@MuteJester
MuteJester deleted the docs-index-paths branch June 18, 2026 12:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant