docs: rename context/→doc/, document the installer, restructure skill wrapper guides#64
Merged
yannrichet-asnr merged 2 commits intoJun 13, 2026
Conversation
… wrapper guides Reorganize the user/agent documentation surface for clarity: - Rename context/ → doc/ (git mv, history preserved) and update all path references in llms.txt, README.md, CLAUDE.md, and internal cross-links. NEWS.md entries left as historical record. - Add doc/installing-models.md: the previously undocumented installer (fz install model|algorithm, uninstall, fz list; install_model / install_algorithm / list_installed_* API; fz-<code> source resolution; project-local vs --global). Wired into llms.txt, README, doc/INDEX.md, doc/README.md. - Fix stale "four core functions" framing → six (fzi/fzc/fzo/fzr/fzl/fzd) in doc/overview.md, doc/README.md, doc/INDEX.md. - Rename skill guides for clearer, symmetric names: skills/fz/wrapper.md → code-wrapper.md, algorithms.md → algorithm-wrapper.md. Expand algorithm-wrapper.md with metadata-header semantics (#options, #require auto-pip-install) and an fz-<name> packaging/publishing section, making it a true peer of code-wrapper.md. - Update all references in SKILL.md, howto.md, the e2e tests, and the static test's filename assertion. Static skill suite passes (tests/test_skill_static.py). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The global .fz ignore is negated by !examples/**, so fz run output under examples/ (tmp dirs, generated calculators) showed as untracked. Re-exclude it. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reorganizes and expands the project’s documentation surface: it renames the modular docs directory from context/ to doc/, adds installer documentation, and updates skill guides and tests to reflect renamed/expanded wrapper docs.
Changes:
- Renamed modular docs directory references (
context/→doc/) across top-level docs and internal cross-links. - Added new documentation pages (installer usage, core functions, calculators, syntax, formulas, caching, examples, fzd content formats).
- Renamed/expanded the fz skill’s algorithm wrapper guide and updated e2e/static tests accordingly.
Reviewed changes
Copilot reviewed 17 out of 26 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_skill_static.py | Updates static skill assertions for renamed algorithm wrapper doc. |
| tests/test_skill_e2e.py | Updates e2e guidance strings to reference code-wrapper.md. |
| skills/test_skill_e2e.md | Updates skill test walkthrough references to code-wrapper.md. |
| skills/howto.md | Updates how-to link from algorithms.md to algorithm-wrapper.md. |
| skills/fz/SKILL.md | Updates wrapper/algorithm guide links to renamed docs. |
| skills/fz/code-wrapper.md | Points algorithm packaging guidance to the new algorithm wrapper guide. |
| skills/fz/algorithms.md | Removes the old algorithm guide (replaced by algorithm-wrapper.md). |
| skills/fz/algorithm-wrapper.md | New/expanded algorithm wrapper + packaging/publishing guidance. |
| README.md | Updates references from context/ to doc/ and adds installing-models.md to the docs list. |
| llms.txt | Updates doc links to doc/ (but still needs skill algorithm link fix per PR comment). |
| doc/syntax-guide.md | New syntax guide (contains a couple of inaccuracies called out in comments). |
| doc/shell-path.md | Updates cross-links from context/ to doc/. |
| doc/README.md | Updates “core functions” framing and doc tree to include new pages. |
| doc/quick-examples.md | New “common patterns”/examples page. |
| doc/parallel-and-caching.md | New parallelism + caching guide. |
| doc/overview.md | Updates overview to “six core functions” and links to new installer doc. |
| doc/model-definition.md | New model definition guide. |
| doc/installing-models.md | New installer documentation (CLI + Python API). |
| doc/INDEX.md | Updates the index and adds an installer section (title wording needs tweak per comment). |
| doc/fzd_content_format.md | Documents fzd analysis content detection/serialization behavior. |
| doc/funz-protocol.md | Updates a cross-link from context/ to doc/. |
| doc/formulas-and-interpreters.md | New formulas/interpreters guide. |
| doc/core-functions.md | New core functions guide (algorithm interface snippet needs correction per comment). |
| doc/calculators.md | New calculators guide (intro needed correction per comment). |
| CLAUDE.md | Updates repo “docs surface” reference from context/ to doc/. |
Comments suppressed due to low confidence (1)
doc/INDEX.md:9
- Even after the directory rename to
doc/, this index still labels the documentation as “Context” in the title/description, which is inconsistent with the new directory naming and may confuse navigation.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+112
to
+116
| ```bash | ||
| fz install algorithm ./fz-myalgo.zip # or the repo path / URL | ||
| fz list # algorithm available? | ||
|
|
||
| # drive it through fzd on a simple input (see code-wrapper.md for wrapping the code) |
Comment on lines
24
to
+28
| ## Documentation | ||
|
|
||
| - [README](README.md): complete user guide with examples | ||
| - [Core functions](context/core-functions.md): fzi, fzc, fzo, fzr, fzl, fzd in detail | ||
| - [Input syntax guide](context/syntax-guide.md): variables, formulas, defaults | ||
| - [Model definition](context/model-definition.md): model structure, aliases, output parsing | ||
| - [Calculators](context/calculators.md): calculator types, URIs, configuration | ||
| - [Formulas and interpreters](context/formulas-and-interpreters.md): Python/R formula evaluation | ||
| - [Parallelism and caching](context/parallel-and-caching.md): performance strategies | ||
| - [Quick examples](context/quick-examples.md): common usage patterns | ||
| - [Core functions](doc/core-functions.md): fzi, fzc, fzo, fzr, fzl, fzd in detail | ||
| - [Installing models and algorithms](doc/installing-models.md): fz install model|algorithm, the fz-<code> convention |
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
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.
Reorganizes the user- and agent-facing documentation surface for clarity and completeness. Docs-only — no code changes.
What changed
context/→doc/git mvso history is preserved; updated every path reference inllms.txt,README.md,CLAUDE.md, and internal cross-links.NEWS.mdmentions intentionally left as a historical record of past releases.New:
doc/installing-models.mdThe installer was a public API + CLI surface (
fz install model|algorithm,fz uninstall,fz list,install_model/install_algorithm/list_installed_*) documented in the README and the skill but absent fromcontext/— a gap against the CLAUDE.md rule that API/CLI changes update all three doc surfaces. This adds it: CLI + Python usage, source resolution (name→github.com/Funz/fz-<code>, URL, local zip), thefz-<code>convention, and project-local vs--global. Wired intollms.txt,README.md,doc/INDEX.md, anddoc/README.md.Fixed stale "four core functions" framing
doc/overview.md,doc/README.md, anddoc/INDEX.mdstill presented fz as having four core functions (fzi/fzc/fzo/fzr); corrected to six (adds fzl, fzd) with usage examples.Skill guide renames + expansion
skills/fz/wrapper.md→code-wrapper.mdskills/fz/algorithms.md→algorithm-wrapper.md, expanded to a true peer ofcode-wrapper.md: metadata-header semantics (#optionsconstructor defaults,#requireauto-pip-install on load) and anfz-<name>packaging/publishing section (.fz/algorithms/<name>.py,fz install algorithm, testing, publish conventions).SKILL.md,howto.md, both e2e test files, and the static test's filename assertion.Verification
tests/test_skill_static.py— 10 passed (validates skill claims against the code, incl. file existence).context//wrapper.md/algorithms.mdreferences remain outside the intentionalNEWS.mdhistory.fz/cli.py(--output_expression,--options/-o).🤖 Generated with Claude Code