Skip to content

Fix docsite: models, analytics, copyright, links - #6

Merged
cabeen merged 4 commits into
mainfrom
fix-docsite
Mar 11, 2026
Merged

cabeen merged 4 commits into
mainfrom
fix-docsite

Conversation

@cabeen

@cabeen cabeen commented Mar 11, 2026

Copy link
Copy Markdown
Owner

Summary

  • Fill out model descriptions for Spharm, Noddi, Kurtosis, and ExpDecay in models.md
  • Switch Google Analytics from deprecated UA (UA-58725032-1) to GA4 (G-TXS7QPGPWV) via custom theme override
  • Update copyright year from 2012-2021 to 2012-2026 in license.md
  • Fix all broken links across 12 docs files:
    • Wiki-style [[links]] in dmri-tutorial, tractography, freesurfer, quickstart
    • Malformed [URL text] links in datasets, modules, install, workflow, masters-workshop
    • Dead Bintray URL for XQuartz in support.md
    • Incorrect installation.md reference (should be install.md) in freesurfer tutorial
    • Old email address in masters-workshop

Test plan

  • MkDocs build succeeds with all changes
  • No remaining wiki-style or malformed links ([[ ]] and [http... text] patterns)
  • Verify GA4 tracking appears in page source after deployment
  • Spot-check links render correctly on deployed site

cabeen added 4 commits March 11, 2026 16:16
- Fill out Spharm, Noddi, Kurtosis, and ExpDecay model descriptions
- Switch Google Analytics from UA to GA4 (G-TXS7QPGPWV)
- Update copyright year from 2012-2021 to 2012-2026
- Fix all wiki-style [[links]] across tutorials and guides
- Fix malformed [URL text] links to proper markdown [text](URL)
- Fix dead Bintray XQuartz download link
- Fix incorrect install.md reference in freesurfer tutorial
Add a single-JVM-invocation flag that generates markdown documentation
for all 475+ modules at once, avoiding per-module startup costs.

- Extract toMarkdown() from CliSpecification for reuse without System.exit
- Add public CliModule.spec() to expose module CLI specifications
- Add --markdown-all handler in QitMain that discovers and documents all modules
Build QIT and run --markdown-all to produce a fresh library.md before
the MkDocs build step. Also trigger docs deployment on src/ changes
since module metadata affects the generated library page.
Replace verbose per-parameter code blocks with compact markdown tables.
Each module section now uses table layout for inputs, parameters, and
outputs with columns for flag, type, default, and description.  Reduces
generated library.md from ~26K to ~13K lines.
@cabeen
cabeen merged commit 5520fe8 into main Mar 11, 2026
1 check passed
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