Skip to content

docs: rename context/→doc/, document the installer, restructure skill wrapper guides#64

Merged
yannrichet-asnr merged 2 commits into
mainfrom
docs/restructure-context-doc-and-skill-wrappers
Jun 13, 2026
Merged

docs: rename context/→doc/, document the installer, restructure skill wrapper guides#64
yannrichet-asnr merged 2 commits into
mainfrom
docs/restructure-context-doc-and-skill-wrappers

Conversation

@yannrichet-asnr

Copy link
Copy Markdown
Member

Reorganizes the user- and agent-facing documentation surface for clarity and completeness. Docs-only — no code changes.

What changed

context/doc/

  • git mv so history is preserved; updated every path reference in llms.txt, README.md, CLAUDE.md, and internal cross-links.
  • NEWS.md mentions intentionally left as a historical record of past releases.
  • No code, packaging, or CI references the directory, so nothing breaks functionally.

New: doc/installing-models.md

The 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 from context/ — a gap against the CLAUDE.md rule that API/CLI changes update all three doc surfaces. This adds it: CLI + Python usage, source resolution (namegithub.com/Funz/fz-<code>, URL, local zip), the fz-<code> convention, and project-local vs --global. Wired into llms.txt, README.md, doc/INDEX.md, and doc/README.md.

Fixed stale "four core functions" framing

doc/overview.md, doc/README.md, and doc/INDEX.md still 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.mdcode-wrapper.md
  • skills/fz/algorithms.mdalgorithm-wrapper.md, expanded to a true peer of code-wrapper.md: metadata-header semantics (#options constructor defaults, #require auto-pip-install on load) and an fz-<name> packaging/publishing section (.fz/algorithms/<name>.py, fz install algorithm, testing, publish conventions).
  • Updated all references in 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).
  • No dangling context/ / wrapper.md / algorithms.md references remain outside the intentional NEWS.md history.
  • CLI flags in the new docs verified against fz/cli.py (--output_expression, --options/-o).

🤖 Generated with Claude Code

… 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>
Copilot AI review requested due to automatic review settings June 13, 2026 12:43
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>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 thread llms.txt
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
@yannrichet-asnr yannrichet-asnr merged commit 221ca39 into main Jun 13, 2026
38 checks 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.

3 participants