Skip to content

Commit

Permalink
Merge pull request #410 from omahs/patch-2
Browse files Browse the repository at this point in the history
Fix typos
  • Loading branch information
pdaoust committed Dec 21, 2023
2 parents 4b98fe8 + 8baf493 commit 6b264e7
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
This repo builds the documentation for developer.holochain.org generated by 11ty (https://www.11ty.dev/).

## A note about browsers
Other than a warning to the user (see `unsupported-brower-warning.njk` if you care) ___no___ effort has been made to accomadate non-Evergreen browsers, which is mostly to say Internet Explorer of any version. There isn't a lot of js in the rendered site, but what there is won't work, and newer CSS features are used as well.
Other than a warning to the user (see `unsupported-brower-warning.njk` if you care) ___no___ effort has been made to accommodate non-Evergreen browsers, which is mostly to say Internet Explorer of any version. There isn't a lot of js in the rendered site, but what there is won't work, and newer CSS features are used as well.

## What the heck is 11ty (an extremely quick intro)
11ty, or Eleventy, is a NodeJS based static website generator. It supports a bunch of template types,
including markdown and nunjucks (https://mozilla.github.io/nunjucks/) which we use here. By default any
template file in the input directory will generate an html file in the generated site. It also supports
includes and data generated content. It is extremely configuarable and as such the docs (https://www.11ty.dev/docs/)
includes and data generated content. It is extremely configurable and as such the docs (https://www.11ty.dev/docs/)
can be a handful, but they are quite good and are worth a look.

## How are we using 11ty
Expand Down Expand Up @@ -57,7 +57,7 @@ There are two reasons for this:
The tag will be added to the `<code>` element as a `language-<tag>` CSS class, along with a `hljs` tag. The surrounding `<pre>` element will also get a `hljs-container` class. We're using the `atom-one-light` theme that ships with highlight.js.

## Using Markdown Here
We are using a mixture of markdown and nunjucks as the main page templates. For documentation pages (as opposed to more blingy pages like the home page) md is prefered.
We are using a mixture of markdown and nunjucks as the main page templates. For documentation pages (as opposed to more blingy pages like the home page) md is preferred.

By default 11ty uses the [markdown-it](https://github.com/markdown-it/markdown-it) parser and we stuck with that.
Additionally the following `markdown-it` plugins have been added:
Expand Down Expand Up @@ -102,6 +102,6 @@ Additionally the following `markdown-it` plugins have been added:
- Builds 11ty with links to the bundled JS and minified CSS
- `clean`: Cleans out the `_site` dir
- `build:search-index`: builds the index files for the search function. This is called as pat of the build process, but if you want the search to work during local dev then you need to run this once, or you can just run `build` before you start the `dev` script.
- `update-browserlist`: Updates the browserlist that autoprefixer uses detirmine what vendor prefixes are needed for your specified browser set. Run once in a while.
- `update-browserlist`: Updates the browserlist that autoprefixer uses determine what vendor prefixes are needed for your specified browser set. Run once in a while.


8 changes: 4 additions & 4 deletions src/pages/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Welcome to the Getting Started with Holochain guide! This guide will walk you th
Follow this guide step by step. All steps are essential to create the example applications. No additional code or steps are needed.

* The examples below use `$` to represent your terminal prompt in a UNIX-like OS, though it may have been customized in your OS to appear differently.
* We assume that you are reading this guide because your are a developer new to Holochain but interested in actually building peer-to-peer distributed applications using a framework that is agent-centric, that provides intrinsic data integrity, is scalable, and when deployed, end-user code runs just on the devices of the participants without relying on centralized servers or blockchain tokens or other points of centralized control.
* We assume that you are reading this guide because you are a developer new to Holochain but interested in actually building peer-to-peer distributed applications using a framework that is agent-centric, that provides intrinsic data integrity, is scalable, and when deployed, end-user code runs just on the devices of the participants without relying on centralized servers or blockchain tokens or other points of centralized control.
* We assume that you've at least skimmed [Holochain's Core Concepts](/concepts/1_the_basics/) or are ready to pop over there when needed.
* Because Holochain's DNA's are written in Rust, we assume you have at least a basic familiarity with the language. Note, however, that this guide will take you through everything you need to do, step-by-step, so you can follow the steps and learn Rust later. Additionally, Holochain DNAs rarely need to take advantage of the more complicated aspects of the language, so don't let Rust's learning curve scare you.
* If you're new to Rust, you can start your learning journey by reading chapters 1 to 11 in the [Rust Book](https://doc.rust-lang.org/book/) and doing the accompanying [Rustlings exercises](https://github.com/rust-lang/rustlings/).
Expand Down Expand Up @@ -200,7 +200,7 @@ This table includes everything in the `hello-world/` folder as well as details o
| <pre> ├── target/ </pre> | A folder containing the compiled output from the Rust build process. |
| <pre> ├── tests/ </pre> | A folder containing JavaScript-base test code for the application. |
| <pre> ├── ui/ </pre> | A folder containing the source code and assets for the web-based user interface of the "Hello, World!" application. This user interface will get distributed along with the application. |
| <pre> ├┬─ workdir/ </pre> | A working folder containing configuration files and compliled artifacts related to the building of the whole hApp. |
| <pre> ├┬─ workdir/ </pre> | A working folder containing configuration files and compiled artifacts related to the building of the whole hApp. |
| <pre> │├── happ.yaml </pre> | The manifest file for the hApp. It references the DNA files to be included, along with the roles they play in the application. In this case, there's only one DNA file, `hello_world`. |
| <pre> │├── hello_world.happ </pre> | The compiled hApp bundle, which includes all the DNAs (in case just the one). |
| <pre> │├── hello_world.webhapp </pre> | The compiled web hApp bundle, which includes the hApp bundle plus the zipped UI. |
Expand Down Expand Up @@ -987,7 +987,7 @@ The scaffolding tool doesn't have any feature for building anchors and trees bey

!!!

Before you get started editing the UI, it's helpful to be able to actually run the scaffolded applciation. That way, you can watch changes take effect in real-time as you make them. So the next section will walk you through launching the application the tooling that's available there, and then in the section after that, we'll begin working with the `.svelte` files to build the UI.
Before you get started editing the UI, it's helpful to be able to actually run the scaffolded application. That way, you can watch changes take effect in real-time as you make them. So the next section will walk you through launching the application the tooling that's available there, and then in the section after that, we'll begin working with the `.svelte` files to build the UI.

### 4.8. Run your application in dev mode

Expand Down Expand Up @@ -1054,7 +1054,7 @@ CommentsForPost.svelte EditPost.svelte

The next step is to edit the UI files in the text editor or integrated development environment of your choice to add scaffolded components and build a fully featured UI. To integrate all of these generated UI elements, you'll need to add them to `App.svelte` file located in the `ui/src/` folder, or to some other `.svelte` file that eventually gets included in `App.svelte`.

If you don't yet have path commands for opening files in your prefered IDE, there are instructions for [VSCode/VSCodium](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line), [Sublime Text](https://www.sublimetext.com/docs/command_line.html#setup) and [WebStorm](https://www.jetbrains.com/help/webstorm/working-with-the-ide-features-from-command-line.html#5d6e8844). Going forward in this tutorial, we are going to use the `code` command when we mean for you to open files in your IDE, but you should substitute a different command (ex: `subl`, `vim`, `emacs` etc.) for `code` if you are using a different editor.
If you don't yet have path commands for opening files in your preferred IDE, there are instructions for [VSCode/VSCodium](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line), [Sublime Text](https://www.sublimetext.com/docs/command_line.html#setup) and [WebStorm](https://www.jetbrains.com/help/webstorm/working-with-the-ide-features-from-command-line.html#5d6e8844). Going forward in this tutorial, we are going to use the `code` command when we mean for you to open files in your IDE, but you should substitute a different command (ex: `subl`, `vim`, `emacs` etc.) for `code` if you are using a different editor.

Open the `App.svelte` file with your preferred IDE.

Expand Down
6 changes: 3 additions & 3 deletions src/pages/references/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ The act of joining an application's [DHT](#distributed-hash-table-dht). Bootstra
1. Finding an initial group of peers to [gossip](#gossip) with via [discovery](#peer-discovery),
2. Establishing connections with those peers,
3. Having one's [membrane proof](#membrane-proof) accepted by those peers,
4. Having one's [transprt address](#transport-address) accepted into those peers' [peer tables](#peer-table), and
4. Having one's [transport address](#transport-address) accepted into those peers' [peer tables](#peer-table), and
5. Gradually having one's transport address gossiped to other peers.

#### Bootstrap service
Expand Down Expand Up @@ -351,7 +351,7 @@ A [public key infrastructure](#public-key-infrastructure-pki) that doesn't rely

#### Distributed system

Any system that involves multiple [nodes](#node) talking to one another over a network, whether [decentralized](#decentralization) or [centralized](#centralization). Because communication isn't instantaneous, different nodes can create conflicting data, particularly in the persence of a [partition](#partition). Many distributed systems use a [coordination protocol](#coordination-protocol) to reach [consistency](#consistency), while others rely on the [CALM theorem](#consistency-as-logical-monotonicity-calm-theorem) to avoid conflicts altogether.
Any system that involves multiple [nodes](#node) talking to one another over a network, whether [decentralized](#decentralization) or [centralized](#centralization). Because communication isn't instantaneous, different nodes can create conflicting data, particularly in the presence of a [partition](#partition). Many distributed systems use a [coordination protocol](#coordination-protocol) to reach [consistency](#consistency), while others rely on the [CALM theorem](#consistency-as-logical-monotonicity-calm-theorem) to avoid conflicts altogether.

#### DNA

Expand Down Expand Up @@ -504,7 +504,7 @@ A property of Holochain's [validating DHT](#validating-dht), whereby healthy [no

#### Inductive validation

The act of relying on inductive reasoning within a [validation function](#validation-function) to validate a piece of data that has dependencies by checking whether the data is valid in the context of its _most immediate dependencies only_. If other validators report that those dependencies are valid, it can be assumed that they have also applied the same inductive reasoning, as have the validators of those dependencies' dependencies, all the way back to the root nodes of the dependency graph. This can greatly speed up complex validation algorithms that operate on data with large dcependency graphs.
The act of relying on inductive reasoning within a [validation function](#validation-function) to validate a piece of data that has dependencies by checking whether the data is valid in the context of its _most immediate dependencies only_. If other validators report that those dependencies are valid, it can be assumed that they have also applied the same inductive reasoning, as have the validators of those dependencies' dependencies, all the way back to the root nodes of the dependency graph. This can greatly speed up complex validation algorithms that operate on data with large dependency graphs.

#### Init callback

Expand Down

0 comments on commit 6b264e7

Please sign in to comment.