Skip to content

Commit b94f449

Browse files
small rewordings
1 parent 3db752f commit b94f449

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

website/docs/building/template-system.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Within the component's `package.json` a template type need to be specified toget
1414

1515
> By convention the compiler need to follow the naming structure: **`<template-type>-compiler`**.
1616
17-
For example a component of type: `oc-template-handlebars` will need a compiler named `oc-template-handlebars-compiler` in order to be correctly packaged and published:
17+
For example a component of type: `oc-template-es6` will need a compiler named `oc-template-es6-compiler` **so it can be** correctly packaged and published:
1818

1919
```json
2020
...

website/docs/components/cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ $ oc clean ../all-components --yes
182182

183183
### dev
184184

185-
Runs a local oc test registry in order to develop and test components
185+
Runs a local oc test registry **to develop and test components**
186186

187187
#### Usage:
188188

@@ -251,7 +251,7 @@ which will create `test-component` in `components` directory.
251251

252252
### mock
253253

254-
Allows to mock configuration in order to facilitate local development
254+
Allows **mocking configuration to simplify local development**
255255

256256
#### Usage
257257

website/docs/consumers/client-side-rendering.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ This is how to integrate the component:
3434
5. In case of error (timeout or 5xx response) the client is going to retry 30 times (retry attempts and timeout are configurable)
3535
6. In case of success, the client is going to find what kind of template the component uses and verify dependencies are satisfied. For ES6 templates (the default), it ensures the template function is ready. For legacy template types like Handlebars, it ensures the respective runtime is available and ready, downloading it if necessary before proceeding to the next step
3636
7. The client will take the compiled view url, for instance `//cdn.com/components/my-component/1.2.3/template.js` and put it in the `<head>` tag, then waiting for it to be ready. If the template is already there (for example because there are multiple components of the same type and version in the page) it is going to skip step 7. When the template is ready it is exposed in the `window.oc.components['hash-of-the-component']` namespace as a function: `view(viewModel)=html`.
37-
8. This is going to take the viewModel (part of the HTTP response) and use it to render the view, in order to obtain the html. When finished, it is going to place the HTML result inside the `<oc-component>` container tag. Some templates may perform additional actions. In case of a React template, for instance, the HTML may be bound to the Virtual DOM.
37+
8. This is going to take the viewModel (part of the HTTP response) and use it to render the view, **producing** the HTML. When finished, it places the HTML result inside the `<oc-component>` container tag. Some templates may perform additional actions. In case of a React template, for instance, the HTML may be bound to the Virtual DOM.
3838
9. An `oc:rendered` event is published containing the pointer to the component, and all the information (version, name, html, etc.)
39-
10. Back to 3) In order to render, in case, nested client-side components
39+
10. Back to 3) **To render nested client-side components, if any are present**
4040

4141
## What can I do in the client-side?
4242

website/docs/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Now, it should be available at `http://my-components-registry.mydomain.com/hello
115115

116116
# Consuming Components
117117

118-
From a consumer's perspective, a component is an HTML fragment. You can render components just on the client-side, just on the server-side, or use the client-side rendering as failover strategy for when the server-side rendering fails (for example because the registry is not responding quickly or is down).
118+
From a consumer's perspective, a component is an HTML fragment. You can render components **client-side, server-side, or fall back to client-side rendering** when server-side rendering fails (for example, if the registry is slow or unavailable).
119119

120120
You don't need Node.js to consume components on the server-side. The registry can provide you rendered components so that you can consume them using any tech stack.
121121

0 commit comments

Comments
 (0)