diff --git a/src/pages/get-started/2-hello-world.md b/src/pages/get-started/2-hello-world.md index aa9b435ca..111828c23 100644 --- a/src/pages/get-started/2-hello-world.md +++ b/src/pages/get-started/2-hello-world.md @@ -16,7 +16,7 @@ cd ~/Holochain When getting started, seeing a simple but fully-functional app can be very helpful. You can have Holochain's scaffolding tool generate a "Hello World!" application (but for a distributed multi-agent world) by typing the following in your command line terminal: ```shell -nix run github:holochain/holonix?ref=main-0.4#hc-scaffold -- example hello-world +nix run "github:holochain/holonix?ref=main-0.4#hc-scaffold" -- example hello-world ``` The scaffolding tool will ask you one question --- what JavaScript package manager you'd like to use in your project. If in doubt, just choose `npm`. diff --git a/src/pages/get-started/3-forum-app-tutorial.md b/src/pages/get-started/3-forum-app-tutorial.md index 07da7360d..cb38d7384 100644 --- a/src/pages/get-started/3-forum-app-tutorial.md +++ b/src/pages/get-started/3-forum-app-tutorial.md @@ -31,7 +31,7 @@ First, let's use the scaffolding tool to generate the basic folders and files fo To start, run the following command in your terminal: ```shell -nix run github:/holochain/holonix?ref=0.4#hc-scaffold -- web-app +nix run "github:/holochain/holonix?ref=0.4#hc-scaffold" -- web-app ``` !!! info Backing out of a mistake diff --git a/src/pages/get-started/index.md b/src/pages/get-started/index.md index aad395191..c5ed3c670 100644 --- a/src/pages/get-started/index.md +++ b/src/pages/get-started/index.md @@ -67,7 +67,7 @@ This command downloads the setup script and runs it, installing the Nix package In a new terminal session type: ```shell -nix run --refresh -j0 -v github:holochain/holonix?ref=main-0.4#hc-scaffold -- --version +nix run --refresh -j0 -v "github:holochain/holonix?ref=main-0.4#hc-scaffold" -- --version ``` Look out for binaries being copied from `holochain-ci.cachix.org`: diff --git a/src/pages/get-started/install-advanced.md b/src/pages/get-started/install-advanced.md index 685ac2c35..b0f40139d 100644 --- a/src/pages/get-started/install-advanced.md +++ b/src/pages/get-started/install-advanced.md @@ -24,7 +24,7 @@ If you want to learn more about how this setup works and how to create it manual The flake-based one-liner to get you an ad-hoc Holonix shell (that is, not using a local flake file) looks like this: ```shell -nix develop github:holochain/holonix?ref=main-0.4 +nix develop "github:holochain/holonix?ref=main-0.4" ``` #### Specifying a certain release @@ -32,7 +32,7 @@ nix develop github:holochain/holonix?ref=main-0.4 The above one-liner will give you the latest **recommended** version of Holochain from the 0.4 release branch. To get an ad-hoc shell with a specific version of Holochain, change the `ref` parameter. For example, if you want to enter a Holochain 0.3 development shell, run: ```shell -nix develop github:holochain/holonix?ref=main-0.3 +nix develop "github:holochain/holonix?ref=main-0.3" ``` The options you should know about are: diff --git a/src/pages/resources/upgrade/upgrade-holochain-0.3.md b/src/pages/resources/upgrade/upgrade-holochain-0.3.md index ce1736299..f0f1574d1 100644 --- a/src/pages/resources/upgrade/upgrade-holochain-0.3.md +++ b/src/pages/resources/upgrade/upgrade-holochain-0.3.md @@ -292,7 +292,7 @@ If you depend on other Holochain crates, then you will need to find compatible v It's likely that you will need to make more changes than have been mentioned above, but hopefully this guide has given you a head start! Here are some other things to look out for in this upgrade: * There have been significant changes to Holochain's data validation. You may see validation failures that you didn't see before upgrading. Our experience of helping people upgrade to dev versions of 0.3 is that these are often due to issues in your app's validation logic, and simply weren't caught before due to issues in Holochain's validation workflow. Please check your validation logic and check whether there might be an issue there. If not, then please reach out on Discord or open a [Github issue](https://github.com/holochain/holochain/issues/new/choose) for help. -* There have been changes to the data structures provided for app validation. This means that you will need to update your validation code to remove some fields that are no longer available. You should check the changelog [here](https://github.com/holochain/holochain/blob/develop-0.3/CHANGELOG.md#hdi-040-beta-dev36). If you need to retain the fields that have been removed for your validation logic, then your best option is probably to scaffold an app for 0.3 and take a look at how its validation code retrieves data that's no longer part of the data structures. You can do this by running `nix run github:holochain/holonix?ref=main-0.3#hc-scaffold -- web-app`. +* There have been changes to the data structures provided for app validation. This means that you will need to update your validation code to remove some fields that are no longer available. You should check the changelog [here](https://github.com/holochain/holochain/blob/develop-0.3/CHANGELOG.md#hdi-040-beta-dev36). If you need to retain the fields that have been removed for your validation logic, then your best option is probably to scaffold an app for 0.3 and take a look at how its validation code retrieves data that's no longer part of the data structures. You can do this by running `nix run "github:holochain/holonix?ref=main-0.3#hc-scaffold" -- web-app`. * There have been significant WebSocket app interface changes for Holochain 0.3. There is a changelog entry [here](https://github.com/holochain/holochain/blob/develop-0.3/CHANGELOG.md#holochain-030-beta-dev47). Most problems will be taken care of by picking the right client versions and following any changes that are required to use the new client. However, if you are integrating with Holochain's app interface directly or maintaining your own client then you should get in touch if you run into any difficulties upgrading. * Databases prior to 0.3 have been unencrypted by default. From 0.3 onwards, databases are always encrypted by default. You can disable this by building Holochain with different options if you need to, or we can show you how to open the encrypted databases. For now, we are assuming that people don't often need to do this, so there is no guide. If this assumption turns out to be wrong, we can create one! * A change was made to help hApp developers spot mistakes in DNA manifests that might catch you out if they contain extra fields or obsolete fields. You can read about this change [here](https://github.com/holochain/holochain/blob/develop-0.3/CHANGELOG.md#holochain_types-030-beta-dev24).