Restructure and correct the documentation site - #3
Merged
Merged
Conversation
Structure
- User Guide split into Templates & Models, Core Functions, Calculators,
Running Studies, Design of Experiments, Installing, AI Agents
- new pages: template syntax, output extraction, timeouts, results &
traceability (layout, case naming, manifest, RO-Crate, input_static),
writing algorithms, installing models, AI agents (plugin, fz-mcp),
CLI reference, constraints & limits, security model
- moved pages redirected (mkdocs-redirects); strict build with link and
anchor validation; requirements.txt pins MkDocs < 2; nav check script
Corrections (each checked by running fz)
- fzr examples passing calculators positionally (4th slot is results_dir)
- callbacks are a dict; fzi returns formulas and static objects too;
fzc writes one sub-directory per case; fzo must target case dirs
- default delimiters: variables () / formulas {} without a delim key
- FZ_RUN_TIMEOUT=0 times out immediately; no timeout for ssh/slurm
- parallelism = number of calculator entries; FZ_MAX_WORKERS only caps
- nonexistent FZ_CACHE_DIR, FZ_UDP_DISCOVERY_PORT, CRITICAL log level,
--timeout flag, slurm_options, n_parallel, funz auto-discovery token
- SLURM (srun / sbatch arrays, resources), funz:// (UDP port), SSH auth
and host keys, cache key (SHA-256 + code_id), cache://_ resume
- plugins installed with fz install model, not pip; per-plugin pages
generated from the wrappers' actual model files
- removed obsolete SUMMARY.md
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012GxLbauyVHBQPCeSow8hdh
- sh:// file-name resolution (P0-8): only words existing in the launch directory and absent from the case are resolved; appended input names remain a trap; old behavior noted for result re-checks - Python 3.14 tested; legacy-cache warning; failing version_cmd; security table lists version_cmd and quoted remote interrupt command - constraints page re-synced with fz doc/limitations.md; --global note - perfect gas example: replace dead links to examples/perfectgas/ Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012GxLbauyVHBQPCeSow8hdh
timeout 0, default delimiters, fzr results_dir guard, fz list output and checks, global-install runner paths, .fz/tmp cleanup; fz <= 1.2 behavior noted where users of the released version are affected. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012GxLbauyVHBQPCeSow8hdh
8 of 10 tasks
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
2 participants
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.
Summary
Restructures the site into separate topics and corrects statements that contradicted fz's behavior. Every correction was checked by running fz. The site describes fz with Funz/fz#99 (doc review + usability fixes); where users of the released fz ≤ 1.2 see a different behavior, a note says so.
Structure
fz-mcp)..fzdirectory & aliases, environment variables, constraints & limits, security model, troubleshooting, release notes.mkdocs-redirects).fz install model <Name>, notpip.Main corrections
fzrexamples passed calculators positionally (the 4th slot isresults_dir).callbacksis a dict;fzialso returns formulas/static objects;fzcwrites one sub-directory per case;fzomust target case directories.?varconversion; first Ctrl+C terminates running cases;cache://_; SLURM (srun/ job arrays, resources);funz://(UDP port); SSH auth and host keys; cache key (SHA-256 +code_id);sh://file resolution after P0-8.FZ_CACHE_DIR,FZ_UDP_DISCOVERY_PORT,CRITICALlog level,--timeoutflag,slurm_options,n_parallel,calculators="funz", invented Funz protocol.timeout=0/FZ_RUN_TIMEOUT=0= no timeout; a model withoutdelimaccepts$(x)and${x};fzrrejects a URI asresults_dir;fz listlists aliases by name and checks theirmodelscommands; global installs run from anywhere; empty.fz/tmp/fz_temp_*removed.examples/perfectgas/in fz replaced; obsoleteSUMMARY.mdremoved.Build
requirements.txtpins MkDocs < 2 (MkDocs 2.0 drops the plugin/theme system).mkdocs build --strict(link and anchor validation) and runstest_site_structure.py(every nav page and redirect built).Test plan
mkdocs build --strictpython test_site_structure.py(49 navigation pages + 5 redirects)Dependency
Merge Funz/fz#99 first: this site links to its
doc/limitations.mdand describes its fixes.🤖 Generated with Claude Code
https://claude.ai/code/session_012GxLbauyVHBQPCeSow8hdh