Skip to content

Commit e611b2c

Browse files
committed
docs(website): latests ajustements prior to release
1 parent 6090c82 commit e611b2c

File tree

2 files changed

+5
-12
lines changed

2 files changed

+5
-12
lines changed

apps/website/docs/getting-started.mdx

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,16 @@ import { IllustrationSnippet } from '@site/components/IllustrationSnippet';
1616

1717
## Install
1818

19-
:::caution
20-
This is documentation for a yet unstable release. The API might change, be advised!
21-
If you are looking for v1 documentation, [jump here](https://github.com/formidable-webview/webshell/tree/dev/1.x#readme).
22-
:::
23-
24-
<InstallPackageSnippet packages="@formidable-webview/webshell@next" />
19+
<InstallPackageSnippet packages="@formidable-webview/webshell" />
2520

2621
## How does it work?
2722

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

3530
## What is a (Web) Feature?
3631

apps/website/docusaurus.config.js

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,9 @@ module.exports = {
2525
disableSwitch: false,
2626
respectPrefersColorScheme: true,
2727
announcementBar: {
28-
id: '__disclaimer__',
28+
id: 'supportus',
2929
content:
30-
'&#9888; This documentation is for the yet unstable V2 of @formidable-webview/webshell. Disclaimer: it is a work in progress!',
31-
backgroundColor: '#ffba00',
32-
textColor: 'black',
30+
'⭐️ If you like webshell, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/formidable-webview/webshell">GitHub</a>! ⭐️',
3331
isCloseable: true
3432
},
3533
prism: {

0 commit comments

Comments
 (0)