Skip to content

Document prebuilt binaries and setup-graphcal - #2028

Merged
shunichironomura merged 5 commits into
mainfrom
docs-prebuilt-binaries
Oct 10, 2026
Merged

shunichironomura merged 5 commits into
mainfrom
docs-prebuilt-binaries

Conversation

@shunichironomura

@shunichironomura shunichironomura commented Oct 9, 2026 •

Copy link
Copy Markdown
Member

Warning

This content was written by an AI agent and must be verified by a human developer. After human verification, this alert may be removed.

Summary

Step 7 of the binary distribution plan: document the prebuilt binaries shipped since v0.0.1-alpha.35 and the setup-graphcal v1 action.

  • docs/{en,ja}/installation.md, reorganized around what a user wants to do:
    • Install with the installer script (macOS / Linux, Windows PowerShell) comes first.
    • Install with a package manager groups cargo binstall (prebuilt) and cargo install (builds from crates.io, needs Rust 1.95+), both using graphcal@<version> while Graphcal is a pre-release.
    • Build from source keeps only the prerequisite list and the build command.
    • Use in GitHub Actions shows a minimal graphcal-lang/setup-graphcal@v1 workflow (graphcal check + graphcal eval), pinned to 0.0.1-alpha.35.
    • Implementation details are removed: install paths, how the engine is embedded, offline builds, and the commit suffix of --version.
    • The Japanese edition was proofread with the yomiyasu skill.
  • README.md: the Quickstart now uses the shell installer and links to the installation guide, instead of saying Rust is required.

Decisions:

  • Heading IDs changed (#requirements, #install-from-cratesio, #build-from-a-source-checkout are gone); no incoming links reference them.
  • The GitHub Actions example pins version because the language still changes between alpha releases. The example version must be bumped manually when it becomes too old.
  • Japanese and English code fences are byte-identical and rendered heading IDs match (checked in the just docs-build output).

AI assistance

  • AI used: yes — Claude Code wrote the documentation changes and this description.
  • Human review of AI-assisted code: pending

Breaking changes

  • No breaking changes
  • Breaking changes; the breaking change label is applied

Make the dist installers the primary installation path, mention
cargo-binstall, and keep crates.io (now the only path that needs Rust)
and source builds as alternatives. Add a GitHub Actions example using
graphcal-lang/setup-graphcal@v1. The README quickstart no longer
requires Rust.
List the installer script first, group cargo-binstall and cargo install
under a package-manager section with one version placeholder, and drop
implementation details (install paths, engine embedding, offline builds)
that users do not need to install Graphcal.
Rerunning the installer replaces the binary with the latest release;
no separate updater is installed.
The installation page now groups cargo-binstall and cargo install under
package managers instead of a crates.io section.
@shunichironomura
shunichironomura merged commit ff07648 into main Oct 10, 2026
47 checks passed
@shunichironomura
shunichironomura deleted the docs-prebuilt-binaries branch October 10, 2026 03:23
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