Branch to accumulate minor fixes from Summit training - #945
Merged
Conversation
PR #761 restructured side quests so `<name>.md` became `<name>/index.md` (URLs now `/side_quests/<name>/`), but missed updating cross-references that still point at the old `.md` filenames. Those links 404 on the deployed site — e.g., the "Debugging Nextflow Workflows" link from working_with_files. Replaces every stale `<segment>.md` link target with `<segment>/` across the English docs. Two segment names also rename: `nf-test.md` → `nf_test/` (the directory uses an underscore, not a hyphen). Translations are AI-regenerated each release, so they're not touched here. Affected English pages: side_quests/working_with_files/index.md side_quests/dev_environment/index.md nf4_science/genomics/02_per_sample_variant_calling.md hello_nextflow/02_hello_channels.md hello_nextflow/06_hello_config.md nextflow_run/next_steps.md nextflow_run/03_config.md hello_nf-core/02_rewrite_hello.md hello_nf-core/04_make_module.md Verified end-to-end against a local mkdocs build: every previously broken target now returns 200 (debugging, nf_test, metadata, workflows_of_workflows, working_with_files), and the user's specific link from working_with_files now resolves to /side_quests/debugging/. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Rob Syme <rob.syme@gmail.com>
…xtflow-io/training into fix/stale-side-quest-md-links
Nothing functional, just text, formatting etc
vdauwera
marked this pull request as draft
April 28, 2026 02:20
✅ Deploy Preview for nextflow-training ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Nextflow linting complete!
💡 Tip: Click filename locations to go directly to that code. View all 47 issuesView formatting changes
|
…uest
Section 6.4 Before/After blocks highlighted the closing brace instead of
the changed path{} line; section 5.1 Before block's comment still said
fromFilePairs while the code it labels uses fromPath.
Section 1.5.1 Before block was missing a highlight for the publish: line change; a few headings referencing COWPY/multiMap lacked backticks used consistently elsewhere in the doc.
… and backtick Section 1.1 After block was missing the highlight for the ch_samplesheet -> ch_samples rename. The Summary's filter example used `it.type`, which throws at runtime since channel elements are [meta, file] tuples, not the meta map itself. Also backtick subMap for consistency with the rest of the doc.
… missing The map operation hardcodes character: row.character, so the key is always created; only its value is null when the column is absent from the datasheet. The prior wording claimed the key itself was never created, which contradicts the actual code shown just above it.
…in illustrative snippet Section 3.5's data structure example used sampleC/sampleC_rep1_*.bam, which doesn't match the patientA/B/C naming used everywhere else in the lesson and in the actual samplesheet. Also add the comma missing between the second and third list elements.
- working_with_files: section 5.2 explicitly drops readNum as unneeded, but section 6 and the Summary silently reintroduced it as unused dead code. Remove it consistently from all post-5.2 destructuring. - splitting_and_grouping: the Summary's join examples used tumor_ch.join(normal_ch), the reverse of the order taught and explained in the lesson body (normal_ch.join(tumor_ch)). Fix order. - metadata: correct an overstated claim that adding a datasheet column automatically surfaces it in the meta map; the map operation itself also needs updating, only the process interface stays unchanged.
Sections 3.2 and 5 still referenced sampleA/B/C in prose and an illustrative snippet, left over from before the lesson was renamed to use patientA/B/C throughout. Only the section 3.5 occurrence was caught in the previous pass.
… variable name Section 4.3 introduces the tokenized filename variable as `patient` and explains the choice explicitly in prose, but sections 5.1 onward (including the Summary's Key patterns code) reverted to `sample` without explanation, leftover from an earlier draft.
…ntion splitting_and_grouping: the Summary used normal_ch/tumor_ch/samples_ch/ intervals_ch (suffix style), contradicting the lesson's own stated rule to use a ch_ prefix for all channel variables, and the naming used consistently throughout the lesson body. Renamed to ch_normal_samples/ch_tumor_samples/ch_joined_samples/ch_intervals. working_with_files: the Summary introduced ch_pairs for the fromFilePairs result, but the lesson body consistently calls this channel ch_files. Renamed to match.
…_environment nf_test: drop a leftover data/ prefix on greetings.csv (no such subdirectory exists), correct "three processes" to the actual two (sayHello, convertToUpper), and align "module-level" terminology with the "process" wording used throughout the body and by nf-test itself. workflows_of_workflows: fix a leftover "messages" comment that should say "greetings" (matching every other reference in the same code block), and correct "four things need to change" to "three", matching the doc's own later recap and the actual three edit subsections. dev_environment: normalize three "VSCode" spellings to "VS Code" for consistency with the ~30 other mentions in the doc.
The training container currently bundles nf-test 0.9.2, whose generated process-test harness uses spread-operator syntax incompatible with Nextflow 26.04's default strict parser, causing a misleading Script compilation failed error instead of the documented test outcome. Flag the actual requirement (0.9.3+) up front so readers can self-diagnose and upgrade before hitting it.
…ut paths
Found by running through all of hello-nextflow in the training container:
- 01_hello_world.md: the -resume example omitted --input, so it wouldn't
actually produce the documented cache hit given the immediately
preceding command
- 02_hello_channels.md: "Before" snippet was missing the params{} wrapper
around the input declaration
- 03_hello_workflow.md: COLLECTED-output.txt file titles were missing the
hello_workflow/ subdirectory, one had wrong-case content, and a quiz
anchor pointed to a renamed heading
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…er walkthrough
Ran through all six hello-nf-core lessons in the real training container
and fixed confirmed discrepancies between the docs and actual execution:
- 01_run_demo.md: removed a stray unstable text fragment from --help output
caused by Rich's live-rendering getting corrupted under non-interactive capture
- 02_rewrite_hello.md: fixed hl_lines miscounts and missing backticks
- 03_use_module.md: fixed missing INFO lines in `nf-core modules info` output,
a broken import-statement ordering/alignment, an unquoted admonition title,
stale linenums/comment text drifted from the core-hello-part2 checkpoint, and
converted the "Checking installed modules" admonition to plain prose showing
the actual command and output (verified: modules list local only shows
registry-tracked modules, unrelated to the local module's file layout)
- 04_make_module.md: fixed wrong linenums, hl_lines miscounts, and
capitalization/backtick inconsistencies
- 05_input_validation.md: fixed JSON indentation and a wrong parameter tag
shown in a success-output example
- solutions/core-hello-part{2,3,4,5}: fixed Channel.topic -> channel.topic,
a regression from the correctly-generated core-hello-start baseline that
had propagated through every downstream checkpoint
Also updated the docker-setup skill to read the training image reference
from the current branch's devcontainer.json (like NXF_VER already does)
instead of hardcoding a tag, so container setup always matches what the
branch under test actually pins.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
vdauwera
marked this pull request as ready for review
July 6, 2026 08:02
Collaborator
Author
|
These are all trivial fixes made by claude which i've double-checked and feel confident in. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.