changes for v1.1.0 (#27)

Co-authored-by: Sylwia Vargas <[email protected]>

Author: jrvidal

docs/.vitepress/config.ts

@@ -23,6 +23,9 @@ const SIDEBAR_DEFAULT = [
   {
     items: [{ text: 'API Reference', link: '/api' }],
   },
+  {
+    items: [{ text: 'Changelog', link: '/changelog' }],
+  },
   {
     items: [{ text: 'Enterprise', link: '/enterprise' }],
   },
@@ -88,6 +91,7 @@ export default defineConfig({
       '/guides/': SIDEBAR_DEFAULT,
       '/tutorial/': SIDEBAR_DEFAULT,
       '/api': SIDEBAR_DEFAULT,
+      '/changelog': SIDEBAR_DEFAULT,
       '/enterprise': SIDEBAR_DEFAULT,
       '/contact': SIDEBAR_DEFAULT,
       '/community-projects': SIDEBAR_DEFAULT,

docs/changelog.md

@@ -0,0 +1,18 @@
+---
+title: &title Changelog
+description: &description Changelog for the WebContainers API library
+head:
+  - ['meta', {property: 'og:title', content: *title}]
+  - ['meta', {name: 'twitter:title', content: *title}]
+  - ['meta', {name: 'twitter:description', content: *description}]
+
+---
+
+# Changelog
+
+## 1.1.0
+
+* The value of the [`Cross-Origin-Embedder-Policy`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cross-Origin-Embedder-Policy) header can be changed now with `BootOptions#coep`.
+* The name of the working directory can be specified through `BootOptions#workdirName`.
+* The default value of the `PATH` environment variable is exposed in `WebContainer#path`.
+* The full path of the working directory is exposed in `WebContainer#workdir`.

docs/guides/configuring-headers.md

@@ -12,7 +12,7 @@ head:
 
 This guide provides an overview on how to configure COOP/COEP headers, including hosting platform configuration.
 
-WebContainers require that your page, even in development, be served with these two headers:
+WebContainers require that your page, even in development, is served with these two headers:
 
 ```yaml
 Cross-Origin-Embedder-Policy: require-corp
@@ -21,6 +21,14 @@ Cross-Origin-Opener-Policy: same-origin
 
 These headers are needed because WebContainer _requires_ SharedArrayBuffer, which, in turn, requires your website to be cross-origin isolated.
 
+Some browsers support a different mode for cross-origin isolation: [`credentialless`](https://caniuse.com/mdn-http_headers_cross-origin-embedder-policy_credentialless). If you wish to serve your content in this way, set your headers instead to:
+```yaml
+Cross-Origin-Embedder-Policy: credentialless
+Cross-Origin-Opener-Policy: same-origin
+```
+and make sure to boot your WebContainer specifying [`coep: 'credentialless'`](/api).
+
+
 ::: info Deep Dive: cross-origin isolation
 Here are a few helpful resources if you'd like to learn more about these topics: