Skip to content

Conversation

@pdaoust
Copy link
Contributor

@pdaoust pdaoust commented Dec 1, 2025

Summary by CodeRabbit

  • Documentation

    • Standardized guides to use hc-spin as the primary dev tool; simplified dependency lists and removed tauri/hc-launch workflow references.
    • Removed a standalone holochain_cli_launch install step.
    • Added npm run start usage notes and examples.
    • Added bootstrap/signaling URL and network-seed options to launch examples.
  • Chores

    • Updated build script flags and bumped hc-spin dependency to align with the new workflow.

✏️ Tip: You can customize this high-level summary in your review settings.

@pdaoust pdaoust requested a review from a team December 1, 2025 18:42
@coderabbitai
Copy link

coderabbitai bot commented Dec 1, 2025

Walkthrough

Switch documentation and examples from a dual-tool dev workflow (hc-launch/tauri + hc-spin) to a single hc-spin workflow: remove hc-launch/tauri references and scripts, update install and WSL guidance, adjust happ launch options (bootstrap/signaling/network-seed), and add build changes (RUSTFLAGS) and hc-spin version bump.

Changes

Cohort / File(s) Change Summary
Getting started & front-end guide
src/pages/build/connecting-a-front-end.md, src/pages/get-started/index.md, src/pages/get-started/install-advanced.md, src/pages/get-started/install-without-nix.md
Replaced hc-launch/tauri guidance with hc-spin-only workflow; removed holochain_cli_launch install steps; simplified apt package lists (removed adwaita-icon-theme and related deps); added explicit npm run start snippet and package-manager note; updated WSL2 SUID sandbox and per-hApp hc-spin notes.
Compatibility docs
src/pages/resources/compatibility/holochain-0.6.md, src/pages/resources/compatibility/index.md
Removed hc-launch entries/rows and references from compatibility tables and CLI-tools list; left scaffolding, hc-spin, and playground entries.
Network, launcher scripts & upgrade guide
src/pages/resources/howtos/running-network-infrastructure.md, src/pages/resources/upgrade/upgrade-holochain-0.6.md
Added bootstrap/signaling URL options and network-seed to happ launch examples; removed tauri launcher edits and tauri-related npm scripts; added new launch:tauri usage replaced by hc-spin-based commands; updated kangaroo Electron config example bootstrap URLs; prepended RUSTFLAGS to build:zomes; bumped hc-spin devDependency from ^0.500.1 to ^0.600.0.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

  • Heterogeneous edits across docs, examples, JSON scripts, and build config increase review surface.
  • Pay extra attention to:
    • Consistency of hc-spin command syntax and package-manager notes across files.
    • Correctness and shell-escaping of the added RUSTFLAGS in build:zomes.
    • Removal of tauri-related scripts to ensure examples remain runnable and no leftover references remain.
    • Network option examples (bootstrap/signaling/network-seed) for clarity and correctness.

Possibly related PRs

Suggested reviewers

  • jost-s
  • ThetaSinner

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: removing hc-launch mentions from documentation and adding removal instructions to the 0.6 upgrade guide, which aligns with changes across all modified files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/remove-hc-launch

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 43c70d4 and 3a55037.

📒 Files selected for processing (2)
  • src/pages/build/connecting-a-front-end.md (1 hunks)
  • src/pages/get-started/install-advanced.md (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/pages/build/connecting-a-front-end.md
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 600
File: src/pages/get-started/install-advanced.md:74-81
Timestamp: 2025-08-28T23:39:06.675Z
Learning: hc-launch may show older Holochain version dependencies (like "holochain 0.5.3") even when other tools show newer versions (like 0.5.5) because hc-launch is only repackaged when necessary for compatibility, not automatically with every Holochain release.
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 594
File: src/pages/resources/howtos/running-network-infrastructure.md:178-185
Timestamp: 2025-07-31T17:05:08.265Z
Learning: pdaoust prefers to ignore the MD047 rule (files should end with a single newline character) in the holochain/docs-pages repository because it's not applicable to the admonition plugin they're using.
📚 Learning: 2025-08-28T23:39:06.675Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 600
File: src/pages/get-started/install-advanced.md:74-81
Timestamp: 2025-08-28T23:39:06.675Z
Learning: hc-launch may show older Holochain version dependencies (like "holochain 0.5.3") even when other tools show newer versions (like 0.5.5) because hc-launch is only repackaged when necessary for compatibility, not automatically with every Holochain release.

Applied to files:

  • src/pages/get-started/install-advanced.md
🪛 LanguageTool
src/pages/get-started/install-advanced.md

[style] ~156-~156: Consider a more concise word here.
Context: ...ault, you'll need to install just a few in order to get this tool to work: ```shell sudo a...

(IN_ORDER_TO_PREMIUM)

🔇 Additional comments (1)
src/pages/get-started/install-advanced.md (1)

132-146: Clear and accurate update to SUID sandbox error guidance.

The expanded explanation properly clarifies that hc-spin (or the npm scripts that invoke it) triggers the AppArmor security issue in Ubuntu 24.04+. The change from "@holochain/hc-spin" to "hc-spin" improves clarity, and narrowing scope to "hApp projects" is more precise.


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 and usage tips.

@pdaoust pdaoust force-pushed the chore/remove-hc-launch branch from d9dfc37 to 43c70d4 Compare December 1, 2025 18:43
Some Holochain runtimes bundle the conductor and a front end host that serves your HTML/JavaScript-based runtimes. Take a look at the [Packaging and Distribution](/get-started/4-packaging-and-distribution/) page from the Get Started guide for the choices.

The Holonix dev environment comes with a runtime called `hc-launch`, which starts Holochain, installs your hApp, and displays a UI for you. The scaffolding tool generates an NPM script that compiles and bundles your back end into a [`.happ` file](/build/happs/#package-a-happ-for-distribution) and starts two instances of the hApp with `hc-launch`. In the root of your project folder, enter:
The Holonix dev environment comes with a runtime called `hc-spin`, which starts a Holochain conductor, installs your hApp into it, and displays a UI for you. The scaffolding tool generates an NPM script that compiles and bundles your back end into a [`.happ` file](/build/happs/#package-a-happ-for-distribution) and starts two instances of the hApp with `hc-spin`. In the root of your project folder, enter:
Copy link
Contributor

@matthme matthme Dec 1, 2025

Choose a reason for hiding this comment

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

I think that's not really correct that hc-spin is part of Holonix. It's an npm package that gets scaffolded into the package.json.

@cocogitto-bot
Copy link

cocogitto-bot bot commented Dec 1, 2025

✔️ 43c70d4...3a55037 - Conventional commits check succeeded.

@holochain-release-automation2 holochain-release-automation2 merged commit 77c6391 into main Dec 1, 2025
8 checks passed
@holochain-release-automation2 holochain-release-automation2 deleted the chore/remove-hc-launch branch December 1, 2025 19:36
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.

4 participants