Skip to content

[codex] Update install docs for General registry#240

Merged
terasakisatoshi merged 2 commits into
mainfrom
codex/update-install-docs
Apr 25, 2026
Merged

[codex] Update install docs for General registry#240
terasakisatoshi merged 2 commits into
mainfrom
codex/update-install-docs

Conversation

@terasakisatoshi
Copy link
Copy Markdown
Member

Summary

  • Update README and docs install instructions to use Pkg.add("RustCall") now that RustCall.jl is registered in Julia's General registry.
  • Keep Pkg.build("RustCall") documented as a helper-library rebuild/troubleshooting step instead of the primary install path.
  • Update example package setup docs and align the example Julia compat with RustCall.jl's Julia 1.12 requirement.

Impact

Users can now follow the standard Julia package installation flow without copying a GitHub URL or developing the local checkout. Contributor/local checkout guidance remains documented separately.

Validation

  • git diff --check
  • rg -n 'not yet registered|Pkg\\.add\\(url=|Julia 1\\.10|1\\.10\\+ required|General registry flow|dev dependency|not registered' README.md docs/src docs/troubleshooting.md examples\n- julia --project=docs docs/make.jl\n\nDocumenter still emits existing warnings about unpublished docstrings, large API HTML output, large example representations, and skipped deployment outside CI, but the docs build exits successfully.

@terasakisatoshi terasakisatoshi marked this pull request as ready for review April 25, 2026 06:16
@terasakisatoshi terasakisatoshi merged commit 5884600 into main Apr 25, 2026
12 checks passed
@terasakisatoshi terasakisatoshi deleted the codex/update-install-docs branch April 25, 2026 06:16
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