Skip to content

Commit

Permalink
docs(website): latests ajustements prior to release
Browse files Browse the repository at this point in the history
  • Loading branch information
jsamr committed Oct 8, 2020
1 parent 6090c82 commit e611b2c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 12 deletions.
11 changes: 3 additions & 8 deletions apps/website/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,16 @@ import { IllustrationSnippet } from '@site/components/IllustrationSnippet';

## Install

:::caution
This is documentation for a yet unstable release. The API might change, be advised!
If you are looking for v1 documentation, [jump here](https://github.com/formidable-webview/webshell/tree/dev/1.x#readme).
:::

<InstallPackageSnippet packages="@formidable-webview/webshell@next" />
<InstallPackageSnippet packages="@formidable-webview/webshell" />

## How does it work?

`@formidable-webview/webshell` exports <APIReference reference="makeWebshell" type="function" />, a <Term id="HOC" /> which
creates augmented <WebView /> components.
This component (from now on, we'll call that *a shell component*), is very similar to the underlying <WebView /> it is decorating, but
will have additional props and eventually, behave slightly differently, depending on the injected Web features passed to <APISymbolFormat reference="makeWebshell" type="function" />.
Hence, these features form an abstraction layer over <WebView />'s <Term id="messaging system" />,
thus the “shell” in <Webshell />. This layer makes it very easy to implement bidirectional communication patterns between Web and Native.
Moreover, these features form an abstraction layer over <WebView />'s <Term id="messaging system" />,
thus the “shell” in <Webshell />. This layer makes it very easy to implement bidirectional communication flows between Web and Native.

## What is a (Web) Feature?

Expand Down
6 changes: 2 additions & 4 deletions apps/website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,9 @@ module.exports = {
disableSwitch: false,
respectPrefersColorScheme: true,
announcementBar: {
id: '__disclaimer__',
id: 'supportus',
content:
'&#9888; This documentation is for the yet unstable V2 of @formidable-webview/webshell. Disclaimer: it is a work in progress!',
backgroundColor: '#ffba00',
textColor: 'black',
'⭐️ If you like webshell, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/formidable-webview/webshell">GitHub</a>! ⭐️',
isCloseable: true
},
prism: {
Expand Down

0 comments on commit e611b2c

Please sign in to comment.