Repository navigation
v1.12.1 — documentation patch
Documentation-only patch. No application behavior changes from v1.12.0.
Added
- Hosted docs site at bfer.land/ResistaMet-GUI, built with mkdocs-material and deployed via a new
docs.ymlGitHub Actions workflow. Eight pages: Home, Installation, Quick Start, Concepts (SMU glossary), Settings, Data Outputs (CSV / HDF5 / legacy JSON column reference for every mode), Troubleshooting, Simulator Fidelity, and Citation. Every claim in the docs is grounded in a specific source-code line (~11,000 lines read this pass: every Python file inresistamet_gui/plustools/generate_screenshots.py). - README documentation map: top-level README now links the 8 hosted docs pages so a visitor landing on the GitHub repo has one click to any reference material.
Changed
CITATION.cfftitle scope-tightened from "for Keithley Sourcemeters" → "for Keithley 2400-family Sourcemeters" to match what the software actually supports (ModelSpectable ininstrument.py). Plain-text + BibTeX citation blocks inREADME.mdanddocs/citation.mdupdated to match. Per-version Zenodo DOIs are immutable so v1.12.0's archive keeps its existing title; the concept-DOI page will pick up the new title on this release.- README slimmed from 286 → 140 lines. Deep per-mode descriptions, full installation paths (VISA backends, Linux Qt packages, per-model envelope, cross-model help), and detailed Quick Start expansions moved to the docs site. Everything dropped from the README is still in the repo — just one click away on the docs site. 2-sentence Statement of Need retained.
- Screenshot generator tolerates
--outpaths outside the repo root. The CI smoke step intest.ymlpasses--out /tmp/screenshots-smoke, which crashed the generator atprint(out_dir.relative_to(ROOT))because/tmpisn't under ROOT. New_pretty()helper falls back to the absolute path whenrelative_toraises ValueError. mkdocs.ymlsite_urlupdated from thepeekperformer.github.iodefault to the actualbfer.land/ResistaMet-GUI/custom-domain URL so canonical link tags andsitemap.xmlare correct.- Paper Acknowledgements add a one-line no-funding statement per JOSS policy.
Fixed
.gitignoreruntime artifact gaps.config.jsonandmeasurement_data/are now gitignored at the project level. CLAUDE.md already describedconfig.jsonas gitignored; this commit makes it true for contributors who don't share Brenden's~/.config/git/ignoreglobal rule..gitignoreforpaper/joss-docs/narrowed frompaper/so future paper assets (figures, additional bib files) can ship without per-file exceptions..claude/settings.local.jsonproject-gitignored so contributors aren't relying on a global ignore rule for their personal Claude Code overrides. CONTRIBUTING.md now documents what the tracked.claude/settings.jsonproject hooks do.
Infrastructure
- PR template (
.github/pull_request_template.md) prompting for summary, change type, hardware testing notes, and test plan. docs.ymlworkflow rebuilds and deploys the mkdocs site on any push tomainthat touchesdocs/**,mkdocs.yml, or the workflow itself.