Skip to content

Commit 72e1ce8

Browse files
committed
update guides
1 parent 6bfcdc8 commit 72e1ce8

37 files changed

Lines changed: 1469 additions & 978 deletions

.github/workflows/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Renders the Quarto site and deploys `_site/` to GitHub Pages on every push to
88
## `generate-reference.yml`
99

1010
Populates **versioned** reference docs for the **whole ecosystem**, driven
11-
entirely from this repo no package repository needs its own workflow. Layout:
11+
entirely from this repo, no package repository needs its own workflow. Layout:
1212

1313
```
1414
reference/<package>/<version>/<namespace>/<name>.qmd
@@ -20,7 +20,7 @@ On manual dispatch (or a weekly schedule) it:
2020
(`openpipeline`, `openpipeline_spatial`, `openpipeline_qc`,
2121
`openpipeline_composed`; `openpipeline_rapids` excluded for now),
2222
2. **caches**: if `reference/<package>/<version>/` already exists, that version
23-
is skipped and never rebuilt so a run does nothing unless a **new** release
23+
is skipped and never rebuilt, so a run does nothing unless a **new** release
2424
has appeared ("latest forward"),
2525
3. for each new version, clones that tag from viash-hub (public, no credentials;
2626
the tag ships the built `target/` the generator reads) and runs
@@ -34,12 +34,12 @@ organized by package + version and can never drift from released code. The
3434
generator must read a **built** package (`target/`), which is why we pull tagged
3535
releases from viash-hub rather than `main` (where `target/` is not committed).
3636

37-
**Setup required:** add repo secret **`GTHB_PAT`** used only as the
37+
**Setup required:** add repo secret **`GTHB_PAT`**: used only as the
3838
`viash_pro_token`, which the generator needs to clone the private
3939
`viash-io/viash_tools` repo. Package fetching itself needs no credentials. This
4040
is the same token the production website workflow uses; reuse that value. Then
4141
run the workflow from the Actions tab (**Generate reference → Run workflow**) to
4242
produce the first PR.
4343

44-
Never hand-edit anything under `reference/<package>/<version>/` a version is
44+
Never hand-edit anything under `reference/<package>/<version>/`, a version is
4545
generated once and then frozen (later runs skip it).

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# openpipeline_docs
22

3-
Draft next-generation documentation site for the **OpenPipeline** ecosystem
3+
Draft next-generation documentation site for the **OpenPipeline** ecosystem,
44
covering single-cell (`openpipeline`) and spatial (`openpipeline_spatial`), plus
55
the cross-cutting `openpipeline_qc`, `openpipeline_rapids`, and
66
`openpipeline_composed` packages.
@@ -26,7 +26,7 @@ index.qmd landing page (single-cell + spatial flows)
2626
get-started/ tutorial: guided first run (Local / Seqera / Viash Hub)
2727
guides/ task-oriented how-tos
2828
concepts/ explanation: MuData, Viash, param_list, pipeline model
29-
reference/ AUTO-GENERATED per package (see below) do not hand-edit
29+
reference/ AUTO-GENERATED per package (see below), do not hand-edit
3030
openpipeline/
3131
openpipeline_spatial/
3232
openpipeline_qc/
@@ -58,4 +58,4 @@ See `.github/workflows/README.md` for the wiring plan.
5858
## Status
5959

6060
Scaffold + design mockup. Narrative content is partially ported from the current
61-
site and partially placeholder see individual pages.
61+
site and partially placeholder, see individual pages.

_quarto.yml

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ project:
66
# Draft site: ship a crawler-blocking robots.txt into the build output.
77
resources:
88
- robots.txt
9+
# Shared single-cell/spatial flow widget, loaded by index.qmd and
10+
# concepts/architecture.qmd via <script src>.
11+
- flow.js
912
# NOTE: team/ is a hand-curated static page for now (sections + roles the flat
1013
# author registry can't express). scripts/generate_team.py is kept for the
1114
# eventual return to auto-generation but is intentionally NOT wired as a
@@ -31,16 +34,25 @@ website:
3134
logo: images/logo-mark.svg
3235
title: "OpenPipeline"
3336
left:
34-
- href: get-started/index.qmd
35-
text: Get started
36-
- href: guides/index.qmd
37-
text: Guides
3837
- href: concepts/index.qmd
3938
text: Concepts
40-
- href: reference/index.qmd
41-
text: Reference
42-
- href: contributing/index.qmd
43-
text: Contributing
39+
# "Workflows" = the curated available-workflows overview. Page still lives
40+
# under concepts/ (kept there to avoid breaking cross-links). The advanced
41+
# developer deep-dive stays in the Concepts hub, not here.
42+
- href: concepts/architecture.qmd
43+
text: Workflows
44+
# "Documentation" groups the practical, do-it materials. Get started is
45+
# also the primary landing-page CTA, so it stays reachable from the hero.
46+
- text: Documentation
47+
menu:
48+
- href: get-started/index.qmd
49+
text: Get started
50+
- href: guides/index.qmd
51+
text: Guides
52+
- href: reference/index.qmd
53+
text: Reference
54+
- href: contributing/index.qmd
55+
text: Contributing
4456
- href: team/index.qmd
4557
text: Team
4658
right:
@@ -55,9 +67,9 @@ website:
5567
- id: guides
5668
title: "Guides"
5769
contents: guides/*
58-
- id: concepts
59-
title: "Concepts"
60-
contents: concepts/*
70+
# Concepts has no sidebar — the concepts index (concepts/index.qmd) is a
71+
# card catalog that serves as the section hub, and the pages run wide
72+
# (flow widget, workflow tables) so the reclaimed width matters.
6173
- id: contributing
6274
title: "Contributing"
6375
contents: contributing/*

concepts/architecture.qmd

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Pipeline architecture"
3-
description: "How OpenPipeline fits into a single-cell project"
2+
title: "Available workflows"
3+
description: "Every workflow OpenPipeline offers, arranged by where it sits in the pipeline."
44
order: 60
55
---
66

@@ -54,7 +54,7 @@ This per-sample H5MU is the unit that flows through all subsequent steps. The
5454
right ingestion workflow depends on your sequencing platform and library type.
5555

5656
::: {.callout-tip appearance="simple"}
57-
**Guide:** [Ingest 10x Genomics data](../guides/ingest-10x.qmd): workflow selection, reference genome setup, and examples.
57+
**Guide:** [Ingestion](../guides/ingest-10x.qmd): workflow selection, reference genome setup, and examples.
5858
:::
5959

6060
| Workflow / component | Package | Description |
@@ -148,7 +148,7 @@ The concatenated object then goes through:
148148
4. **PCA**: a principal-component embedding is computed.
149149

150150
::: {.callout-tip appearance="simple"}
151-
**Guide:** [Process & filter samples](../guides/process-filter.qmd): full details and examples.
151+
**Guide:** [Sample processing](../guides/process-filter.qmd): full details and examples.
152152
:::
153153

154154
:::{.callout-note}
@@ -176,7 +176,7 @@ OpenPipeline provides one workflow per integration method. There is no single
176176
default; the right choice depends on dataset size and batch structure.
177177

178178
::: {.callout-tip appearance="simple"}
179-
**Guide:** [Integrate with Harmony or scVI](../guides/integrate.qmd): guidance on choosing a method.
179+
**Guide:** [Integration](../guides/integrate.qmd): guidance on choosing a method.
180180
:::
181181

182182
| Workflow | Package | Method | Description |
@@ -198,7 +198,7 @@ separately from the core pipeline and depends on the tissue and biological
198198
question.
199199

200200
::: {.callout-tip appearance="simple"}
201-
**Guide:** [Annotate cell types](../guides/annotate.qmd): details and examples.
201+
**Guide:** [Cell type annotation](../guides/annotate.qmd): details and examples.
202202
:::
203203

204204
| Workflow | Package | Description |

0 commit comments

Comments
 (0)