Skip to content

docs(setup): add registry fallback note for text-completion inferlet#448

Open
zatchbell1311-wq wants to merge 1 commit into
pie-project:mainfrom
zatchbell1311-wq:fix/setup-registry-text-completion-warning
Open

docs(setup): add registry fallback note for text-completion inferlet#448
zatchbell1311-wq wants to merge 1 commit into
pie-project:mainfrom
zatchbell1311-wq:fix/setup-registry-text-completion-warning

Conversation

@zatchbell1311-wq

@zatchbell1311-wq zatchbell1311-wq commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Fixes the common failure mode reported in #290 where pie run text-completion returns 404 or a component linker error because the registry inferlet lags behind the current engine version. Adds a note before the command with the local build fallback that resolves the issue.

Summary by CodeRabbit

Documentation

  • Added troubleshooting guidance in the setup documentation explaining registry-backed execution limitations. Provides step-by-step instructions for building and running inferlets locally when registry access fails, including how to configure explicit deployment paths.

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

A new callout block is added to website/docs/guide/setup.mdx under the "Run your first prompt" section. It explains the difference between registry-backed and local execution, and provides fallback build instructions (including the wasm32-wasip2 target) for when registry execution fails with a 404 or missing component instance.

Changes

Setup Guide Registry Fallback

Layer / File(s) Summary
Registry vs local build callout
website/docs/guide/setup.mdx
Inserts a note explaining registry lag and missing component failures for pie run text-completion, with step-by-step instructions to build the inferlets/text-completion inferlet locally (adding the wasm32-wasip2 target) and run pie run with explicit .wasm and Pie.toml paths.

Possibly related PRs

  • pie-project/pie#288: Updates the "Writing Inferlets" documentation with setup, build, and pie run instructions for the wasm32-wasip2 target, directly overlapping with the local build fallback guidance added in this PR.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding documentation about a registry fallback note for the text-completion inferlet, which directly matches the PR's objective of addressing setup failure modes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
website/docs/guide/setup.mdx (1)

66-69: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Consider simplifying "lag behind" for conciseness.

The phrase "lag behind the current engine" is clear but slightly wordy. Consider: "the registry may lag the current engine version" or simply "the registry may lag behind."

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@website/docs/guide/setup.mdx` around lines 66 - 69, In the note section
titled "Registry vs local build", the phrase "lag behind the current engine" is
verbose and can be simplified. Replace "lag behind the current engine" with a
more concise alternative such as "lag the current engine version" or simply "lag
behind" to improve readability while maintaining clarity about the registry
potentially having outdated components.

Source: Linters/SAST tools

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@website/docs/guide/setup.mdx`:
- Around line 66-69: In the note section titled "Registry vs local build", the
phrase "lag behind the current engine" is verbose and can be simplified. Replace
"lag behind the current engine" with a more concise alternative such as "lag the
current engine version" or simply "lag behind" to improve readability while
maintaining clarity about the registry potentially having outdated components.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ad9ad385-1761-46d9-b7b9-3ae8d50532d3

📥 Commits

Reviewing files that changed from the base of the PR and between 9ba726a and e7bb7a2.

📒 Files selected for processing (1)
  • website/docs/guide/setup.mdx

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