Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
f46b914
New docs architecture
christopher-hakkaart Feb 18, 2026
5f8b0a0
Add env to gitignore
christopher-hakkaart Feb 18, 2026
0fbb672
Add comment for reminder
christopher-hakkaart Feb 19, 2026
fd3b219
Add comment for reminder
christopher-hakkaart Feb 19, 2026
6ac8063
Frontmatter test
christopher-hakkaart Feb 19, 2026
e9c3a6f
Tidy some formatting
christopher-hakkaart Feb 20, 2026
99a04ba
Update place holders
christopher-hakkaart Feb 22, 2026
c4c293d
Update overview
christopher-hakkaart Feb 22, 2026
2ffab43
Added basic frontmatter
christopher-hakkaart Feb 22, 2026
64e88a6
Update admonition
christopher-hakkaart Feb 23, 2026
e5d14cb
Fix sidebar version
christopher-hakkaart Feb 23, 2026
b9ce1b5
Remove excess files
christopher-hakkaart Feb 23, 2026
9c8ec7a
Remove admonitions over 4 years old
christopher-hakkaart Feb 23, 2026
cfe82da
Tidy admonitions
christopher-hakkaart Feb 23, 2026
bb74df5
Remove versions
christopher-hakkaart Feb 25, 2026
6c39083
Remove versions
christopher-hakkaart Feb 25, 2026
817835f
Updates 25-2
christopher-hakkaart Feb 25, 2026
aa4fcb6
Update keys
christopher-hakkaart Mar 3, 2026
b53f5a5
Update docs
christopher-hakkaart Mar 5, 2026
3f4418c
Update docs
christopher-hakkaart Mar 6, 2026
665d2cb
Update descriptions for llms
christopher-hakkaart Mar 6, 2026
f56889f
Fix link and defualt value
christopher-hakkaart Mar 9, 2026
2f6ba64
Add new records
christopher-hakkaart Mar 16, 2026
9d965c0
Fix transfer
christopher-hakkaart Mar 16, 2026
c0643cc
Update to March 18
christopher-hakkaart Mar 19, 2026
33f6022
Update to March 18
christopher-hakkaart Mar 19, 2026
2aa5a76
Update to March 26
christopher-hakkaart Mar 26, 2026
b4dd53c
Merge in master and resolve conflicts
christopher-hakkaart Mar 26, 2026
6c87b3a
Remove tags
christopher-hakkaart Apr 7, 2026
3c09aa4
Add full llms file
christopher-hakkaart Apr 8, 2026
f3e169b
Search bar and content updates
christopher-hakkaart Apr 9, 2026
c23df50
Update docs 10-04
christopher-hakkaart Apr 10, 2026
6aa1a50
Update April 14 plus architecture
christopher-hakkaart Apr 13, 2026
568b3bd
Add migration guide
christopher-hakkaart Apr 16, 2026
34cc4f4
Add links to misc
christopher-hakkaart Apr 16, 2026
af0d6a3
Remove channel page
christopher-hakkaart Apr 18, 2026
562fbe0
Update to 19-04
christopher-hakkaart Apr 20, 2026
b4904ae
Update 21-04
christopher-hakkaart Apr 21, 2026
7044edb
Custom css to fix table
christopher-hakkaart Apr 24, 2026
2e5ca36
Fix typo
christopher-hakkaart Apr 24, 2026
8a0715e
Update 28-04
christopher-hakkaart Apr 27, 2026
46849e2
Update docs
christopher-hakkaart Apr 28, 2026
db7a247
Redirects
christopher-hakkaart Apr 29, 2026
a35a4e3
Remove Netlify build artifacts from tracking
christopher-hakkaart May 5, 2026
08dc7ef
Remove Netlify artifacts from tracking
christopher-hakkaart May 5, 2026
d9d2ba8
Merge conflicts
christopher-hakkaart May 6, 2026
fbf2306
Fix merge conflicts
christopher-hakkaart May 6, 2026
ce0ea36
Update gitignore
christopher-hakkaart May 6, 2026
f5a954a
Fix missing image and katex
christopher-hakkaart May 6, 2026
b0e26e8
Merge branch 'master' into docs-migration
christopher-hakkaart May 6, 2026
bd290f2
Tidy stway files after merge conflicts
christopher-hakkaart May 6, 2026
93c4e67
Fix dependencies
christopher-hakkaart May 7, 2026
671ff72
Update workflow docs test
christopher-hakkaart May 7, 2026
3f250fb
Update test
christopher-hakkaart May 7, 2026
58b4ed9
Merge remote-tracking branch 'origin/master' into docs-migration
christopher-hakkaart May 7, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
275 changes: 275 additions & 0 deletions .claude/commands/convert-definition-lists.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,275 @@
---
description: Convert Markdown definition lists to heading format for any documentation page
---

# Convert Definition Lists to Headings

Convert Markdown definition list syntax to heading format across all documentation pages including CLI options, environment variables, configuration settings, and API parameters.

## Task

Search for and convert all definition list entries from the MyST definition list syntax:
```markdown
`term`
: Description text here.
```

To heading format:
```markdown
##### `term`

Description text here.
```

This applies to various documentation contexts:
- CLI options and flags
- Environment variables
- Configuration settings
- API/function parameters
- Type definitions
- Any other documented items using definition lists

## Conversion Rules

### Top-Level Definition Lists (h5 headings)

Use h5 headings (`#####`) for top-level items that are primary documentation entries.

1. **Simple definitions:**
```markdown
`TERM_NAME`
: Description text here.
```
Converts to:
```markdown
##### `TERM_NAME`

Description text here.
```

2. **With default values or metadata:**
```markdown
`NXF_OPTS` (`-Xms512m`)
: JVM options for Nextflow execution.
```
Converts to:
```markdown
##### `NXF_OPTS` (`-Xms512m`)

JVM options for Nextflow execution.
```

3. **Multi-line descriptions:**
```markdown
`NXF_WORK`
: Directory where working files are stored.

Default: `./work`
```
Converts to:
```markdown
##### `NXF_WORK`

Directory where working files are stored.

Default: `./work`
```

### Examples by Documentation Type

**Environment Variables:**
```markdown
`NXF_HOME`
: Nextflow home directory
```
→ `##### `NXF_HOME``

**CLI Options:**
```markdown
`-with-docker`
: Enable Docker container execution
```
→ `##### `-with-docker``

**Configuration Settings:**
```markdown
`process.executor`
: Defines the executor to use
```
→ `##### `process.executor``

## Embedded Definition Lists (h6 headings)

Embedded definition lists are indented and represent nested or sub-items within a section. These should be converted to h6 headings to preserve hierarchy.

### Pattern

```markdown
`nestedItem`
: Description text here (default: *value*)
```

### Conversion Format

**Primary conversion to h6 heading (default):**
```markdown
###### `nestedItem`

Description text here (default: *value*)
```

### Examples by Context

**Function Parameters:**
```markdown
`maxDepth: int`
: Maximum number of directory levels to visit (default: *no limit*)
```
```markdown
###### `maxDepth: int`

Maximum number of directory levels to visit (default: *no limit*)
```

**Configuration Sub-options:**
```markdown
`retry.maxAttempts`
: Maximum number of retry attempts
```
```markdown
###### `retry.maxAttempts`

Maximum number of retry attempts
```

**Type Properties:**
```markdown
`name: String`
: The name of the resource
```
```markdown
###### `name: String`

The name of the resource
```

### Alternative Formats

For very compact lists or where h6 headings are too prominent:

**Option A: Bold inline format:**
```markdown
- **`item`** - Description text here
```

**Option B: Simple list:**
```markdown
- `item`: Description text here
```

**When to use alternatives:** Only when the documentation context specifically requires a more compact format, or when there are many simple items in quick succession.

## Steps

1. **Search for definition lists** using Grep:
- Top-level: lines with backtick-wrapped terms followed by `: ` on next line (no leading whitespace)
- Embedded: indented lines (with leading spaces) with backtick-wrapped terms followed by `: `

2. **Determine heading level** based on indentation and context:
- **No indentation** → Top-level item → h5 heading (`#####`)
- **Indented (2-4 spaces)** → Nested item → h6 heading (`######`)

3. **For each match:**
- Read surrounding context to capture full definition including multi-line descriptions
- Note any special formatting within descriptions (code blocks, lists, emphasis)

4. **Convert using Edit tool:**
- **Top-level**: Replace with `##### ` + term, remove `: ` prefix, add blank line
- **Embedded**: Replace with `###### ` + term, remove indentation and `: ` prefix, add blank line
- Preserve all formatting within description text

5. **Handle edge cases:**
- Items with no description (rare but possible)
- Nested content like code blocks, lists, or tables within descriptions
- Multiple consecutive definition list items
- Mixed indentation levels
- Special characters in terms (backticks, colons, etc.)

## Pattern Matching

### Top-Level Definition Lists (h5)

**Pattern:**
```
`TERM`
: Description
```

**Characteristics:**
- Line starts with backtick (no leading whitespace)
- Term can be: environment variable, CLI option, config setting, type name, etc.
- Next line starts with `: ` (colon + space)
- Description may span multiple lines

**Common forms:**
- `` `ENV_VAR` `` - Environment variables
- `` `-option` `` - CLI flags
- `` `config.setting` `` - Configuration options
- `` `TypeName` `` - Type definitions
- `` `functionName()` `` - Function/method names

### Embedded Definition Lists (h6)

**Pattern:**
```
`nestedTerm`
: Description
```

**Characteristics:**
- Line starts with 2-4 spaces of indentation
- Term wrapped in backticks
- Next line indented with `: ` prefix
- Represents nested or sub-items

**Common forms:**
- `` `paramName: type` `` - Function parameters
- `` `property` `` - Object properties
- `` `subOption` `` - Nested configuration options
- `` `field` `` - Data structure fields

## Important Notes

### Formatting Preservation
- Preserve all formatting within descriptions: code blocks, lists, emphasis, links, etc.
- Keep default values in parentheses or emphasis exactly as-is
- Maintain relative indentation within multi-line descriptions

### Heading Levels
- **Top-level (no indent)** → h5 (`#####`) - one blank line between heading and description
- **Embedded (indented)** → h6 (`######`) - remove indentation, add one blank line between heading and description

### Common Uses Across Documentation
- **Environment variables** (env-vars pages)
- **CLI options and flags** (CLI reference pages)
- **Configuration settings** (config reference pages)
- **Function/method parameters** (API documentation)
- **Type properties** (type reference pages)
- **Feature flags** (feature documentation)

### Best Practices
- Work systematically top-to-bottom to avoid missing entries
- Read surrounding context to determine correct heading level
- Verify document structure and hierarchy after conversion
- Test rendering in documentation preview if available
- Use `replace_all: false` in Edit tool to handle each occurrence individually when patterns repeat

### Context Awareness
When uncertain about conversion format, consider:
- Where does this item appear in the document hierarchy?
- Is it a primary entry or a nested sub-item?
- What's the surrounding content structure?
- Would h6 preserve or break the logical flow?
58 changes: 58 additions & 0 deletions .claude/commands/convert-myst-admonitions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
description: Convert MyST-style version admonitions to JSX tag format
---

# Convert MyST Admonitions to JSX Tags

Convert all version admonitions in MDX files from the old MyST colon-fence format to the new JSX tag-based format.

## Task

Search for and convert all instances of:
- `:::{versionadded} X.Y.Z` → `<AddedInVersion version="X.Y.Z" />`
- `:::{deprecated} X.Y.Z` → `<DeprecatedInVersion version="X.Y.Z" />`
- `:::{versionchanged} X.Y.Z` → `<ChangedInVersion version="X.Y.Z" />`

## Conversion Rules

1. **Simple admonitions (empty body):**
```markdown
:::{versionadded} X.Y.Z
:::
```
Converts to:
```markdown
<AddedInVersion version="X.Y.Z" />
```

2. **Admonitions with description (multi-line body):**
```markdown
:::{deprecated} X.Y.Z
Some description text here.
:::
```
Converts to:
```markdown
<DeprecatedInVersion version="X.Y.Z">
Some description text here.
</DeprecatedInVersion>
```

## Steps

1. Use Grep to find all occurrences of `:::{versionadded}`, `:::{deprecated}`, and `:::{versionchanged}` patterns
2. Read the context around each match to understand the full admonition structure
3. Convert each admonition using Edit tool with appropriate old_string/new_string
4. For duplicate patterns that appear multiple times, include enough surrounding context to make each match unique
5. Verify the file has the correct imports at the top:
```javascript
```
6. After all conversions, verify no old-format admonitions remain using Grep

## Important Notes

- Preserve all surrounding formatting, spacing, and content exactly as-is
- Handle each occurrence individually with sufficient context for unique matching
- Use self-closing tags (`/>`) for empty admonitions
- Use container tags with content for admonitions with descriptions
- Work systematically from top to bottom of the file to avoid confusion with line number shifts
19 changes: 12 additions & 7 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,19 @@ jobs:
docs-build:
name: Build
runs-on: ubuntu-latest
defaults:
run:
working-directory: docs
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
- uses: actions/setup-node@v4
with:
python-version: '3.9'
node-version: '20'
cache: 'npm'
cache-dependency-path: docs/package-lock.json

- name: Test docs build
run: |
cd docs/
pip install -r requirements.txt
make clean html
- name: Install dependencies
run: npm ci

- name: Build docs
run: npm run build
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
.cache/*
.vagrant/*
.cache/*
.netlify/
.nextflow*
.node-nextflow*
.devcontainer
Expand Down Expand Up @@ -45,4 +46,5 @@ plugins-prod
/test-module
/results
/x/*
mise.toml
mise.toml
docs/.netlify/
2 changes: 0 additions & 2 deletions docs/.dockerignore

This file was deleted.

Loading
Loading