-
Notifications
You must be signed in to change notification settings - Fork 7
docs: Skill update #1625
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
christopher-hakkaart
wants to merge
2
commits into
master
Choose a base branch
from
chris-skill-update
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
docs: Skill update #1625
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Fusion (exclusive rules) | ||
|
|
||
| Exclusive terminology and formatting rules for **Fusion** docs (`fusion_docs/`). | ||
| These layer *on top of* the core references, including `../core/terminology.md`. | ||
|
|
||
| Core `../core/terminology.md` already covers the Fusion **name** (capitalized; the | ||
| Fusion file system) and the general house rules. Don't duplicate those here — | ||
| this file is for rules exclusive to Fusion. | ||
|
|
||
| > **Scaffold.** Populate from the Fusion docs themselves — **do not invent** | ||
| > feature names, config keys, or product behavior; flag anything you can't | ||
| > confirm (SKILL.md rule 8). Wave is often used alongside Fusion — see `wave.md`. | ||
|
|
||
| ## Feature and entity names | ||
|
|
||
| <!-- Lowercase common nouns for Fusion's own concepts (per the pattern in | ||
| ../core/terminology.md). Populate from Fusion docs: e.g. mount, cache, client. --> | ||
|
|
||
| _None confirmed yet._ | ||
|
|
||
| ## Config, env vars, and mount paths | ||
|
|
||
| <!-- Fusion-specific config keys, environment variables, and mount paths, in backticks. --> | ||
|
|
||
| _None confirmed yet._ |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # MultiQC (exclusive rules) | ||
|
|
||
| Exclusive terminology and formatting rules for **MultiQC** docs (`multiqc_docs/`). | ||
| These layer *on top of* the core references, including `../core/terminology.md`. | ||
|
|
||
| Core `../core/terminology.md` already covers the MultiQC **name** (exact | ||
| capitalization `MultiQC`; not "multiqc", "multiQC", or "multi-qc") and the | ||
|
christopher-hakkaart marked this conversation as resolved.
|
||
| general house rules. Don't duplicate those here — this file is for rules | ||
| exclusive to MultiQC. | ||
|
|
||
| > **Scaffold.** Populate from the MultiQC docs themselves — **do not invent** | ||
| > module names, CLI flags, or product behavior; flag anything you can't confirm | ||
| > (SKILL.md rule 8). | ||
|
|
||
| ## Feature and entity names | ||
|
|
||
| <!-- Lowercase common nouns for MultiQC's own concepts (per the pattern in | ||
| ../core/terminology.md). Populate from MultiQC docs: e.g. module, report, sample, | ||
| general statistics table. --> | ||
|
|
||
| _None confirmed yet._ | ||
|
|
||
| ## Commands, flags, and config | ||
|
|
||
| <!-- MultiQC-specific CLI command (`multiqc`), flags, and config keys, in backticks. --> | ||
|
|
||
| _None confirmed yet._ | ||
38 changes: 38 additions & 0 deletions
38
.claude/skills/docs-deslop/references/products/nextflow.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Nextflow (exclusive rules) | ||
|
|
||
| Exclusive terminology and formatting rules for **Nextflow** docs, and for | ||
| Nextflow code and concepts referenced inside other products' docs. These layer | ||
| *on top of* the core references, including `../core/terminology.md`. | ||
|
|
||
| Core `../core/terminology.md` already covers the Nextflow **name** (not "NextFlow", | ||
|
christopher-hakkaart marked this conversation as resolved.
|
||
| "next-flow", or lowercase "nextflow" in prose), nf-core (lowercase, hyphenated), | ||
|
christopher-hakkaart marked this conversation as resolved.
|
||
| the pipeline-vs-workflow distinction, run vs task vs process, and the `NXF_*` | ||
| environment variables. Don't duplicate those here. The rules below are exclusive | ||
| to Nextflow. Don't invent DSL behavior or directive names — flag anything you | ||
| can't confirm (SKILL.md rule 8). | ||
|
|
||
| ## DSL terms | ||
|
|
||
| Nextflow DSL keywords and concepts are code — write them in backticks, and use | ||
| the term precisely: | ||
|
|
||
| | Term | Meaning | | ||
| | ---------- | ----------------------------------------------------------------------- | | ||
| | `workflow` | The `workflow { }` block that composes processes | | ||
| | `process` | The `process { }` block that defines a task | | ||
| | channel | The async data structure connecting processes (`Channel` factory in code) | | ||
| | operator | A channel transformation (`map`, `collect`, `mix`, …) | | ||
| | executor | The backend that runs tasks (local, SLURM, AWS Batch, …) | | ||
| | directive | A process setting (`cpus`, `memory`, `container`, …) | | ||
|
|
||
| - ✅ "The `workflow` block wires processes together with channels." | ||
| - ❌ "The pipeline block wires the pipeline steps together." (imprecise; "pipeline" is a Seqera Platform term — see `../core/terminology.md`) | ||
|
|
||
| ## Config and command-line conventions | ||
|
|
||
| - `nextflow.config` — the pipeline configuration file (in backticks). | ||
| - Config scopes are code: `process`, `params`, `docker`, `aws`, `tower`, and so on. | ||
| - **Single vs double dash:** Nextflow core options take a single dash (`-resume`, | ||
| `-profile`, `-c`); pipeline parameters take two (`--input`, `--outdir`). Preserve | ||
| the exact dash count — it is a common and consequential error. | ||
| - `params.<name>` in code corresponds to `--<name>` on the command line. | ||
23 changes: 23 additions & 0 deletions
23
.claude/skills/docs-deslop/references/products/platform.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Seqera Platform (exclusive rules) | ||
|
|
||
| Exclusive terminology and formatting rules for **Seqera Platform** docs — Platform | ||
| Cloud, Platform Enterprise, the CLI (`tw`), and the API. These layer *on top of* | ||
| the core references, including `../core/terminology.md`. | ||
|
|
||
| The core `../core/terminology.md` is already Platform-centric: it covers the product | ||
| and tool names, lowercase feature nouns, pipeline vs workflow, run vs task vs | ||
| process, bold vs backticks, the UI element names (**Launchpad**, **Data | ||
| Explorer**, **Compute Envs**, …), and the `TOWER_*` environment variables. Apply | ||
| all of that from core — do **not** duplicate it here. | ||
|
|
||
| This file is for rules that are exclusive to Seqera Platform and go *beyond* the | ||
| shared core terminology. There are none yet. | ||
|
|
||
| ## Platform-exclusive rules | ||
|
|
||
| <!-- Add rules here that apply only to Seqera Platform and are not already in | ||
| ../core/terminology.md — for example, edition-specific wording (Cloud vs | ||
| Enterprise), or Platform UI/behavior details finer-grained than the core | ||
| UI-name list. Don't invent; flag unconfirmed terms (SKILL.md rule 8). --> | ||
|
|
||
| _None yet._ |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # Wave (exclusive rules) | ||
|
|
||
| Exclusive terminology and formatting rules for **Wave** docs (`wave_docs/`). These | ||
| layer *on top of* the core references, including `../core/terminology.md`. | ||
|
|
||
| Core `../core/terminology.md` already covers the Wave **name** (capitalized; the | ||
| container provisioning service) and the general house rules. Don't duplicate | ||
| those here — this file is for rules exclusive to Wave. | ||
|
|
||
| > **Scaffold.** Populate from the Wave docs themselves — **do not invent** feature | ||
| > names, CLI flags, or product behavior; flag anything you can't confirm | ||
| > (SKILL.md rule 8). Fusion is often used alongside Wave — see `fusion.md`. | ||
|
|
||
| ## Feature and entity names | ||
|
|
||
| <!-- Lowercase common nouns for Wave's own concepts (per the pattern in | ||
| ../core/terminology.md). Populate from Wave docs: e.g. container, build, freeze, | ||
| augmentation layer. --> | ||
|
|
||
| _None confirmed yet._ | ||
|
|
||
| ## Commands, flags, and config | ||
|
|
||
| <!-- Wave-specific CLI commands, flags, and config keys, in backticks. --> | ||
|
|
||
| _None confirmed yet._ |
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
File renamed without changes.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.