docs: upgrade guide (#913)

feat: fix

Update v0.1.0.md

Author: baseplate-admin

apps/docs/docs/backend/architecture.md

@@ -55,5 +55,5 @@ flowchart TD
 ```
 
 <small>
-    The [frontend architecture](../frontend/architecture.md) and the [overall architecture](../architecture/index.md)
+    The [frontend architecture](../frontend/architecture.md) and the [overall architecture](../architecture.md)
 </small>

apps/docs/docs/frontend/architecture.md

@@ -82,5 +82,5 @@ flowchart TD
 ```
 
 <small>
-    The [backend architecture](../backend/architecture.md) and the [overall architecture](../architecture/index.md)
+    The [backend architecture](../backend/architecture.md) and the [overall architecture](../architecture.md)
 </small>

apps/docs/docs/upgrade-guides/v0.1.0.md

@@ -0,0 +1,39 @@
+To allow for file preview using WASM, `chithi` required some breaking changes, but we've worked hard to make sure that the upgrade path was smooth as possible.
+
+## Installation
+
+Update your `chithi` to latest version using docker-compose.
+
+Inside your docker compose directory for chithi deployment:
+```shell
+docker compose pull
+```
+
+Then:
+```shell
+docker compose up -d
+```
+
+
+## Breaking changes
+### Chithi frontend needs COOP and COEP headers
+In previous version of `chithi`, we didn't do in browser convertion of files.
+
+Now `chithi` supports the following transformations:
+
+* SVG -> PNG (using [@resvg/resvg-wasm](https://www.npmjs.com/package/@resvg/resvg-wasm))
+* HEIC -> PNG (using [heic-to](https://www.npmjs.com/package/heic-to))
+* JXL -> PNG (using [@jsquash/jxl](https://www.npmjs.com/package/@jsquash/jxl))
+
+To accomodate these with wasm threads, we have to enable [COOP](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Cross-Origin-Opener-Policy) and [COEP](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Cross-Origin-Embedder-Policy) headers.
+
+You can read an [article on web.dev](https://web.dev/articles/why-coop-coep) on why COOP and COEP headers are needed.
+
+!!! info
+
+    While the site itself does not change much in meaningful way, having no COOP and COEP headers mean your fonts and other assets wont load properly.
+
+That means your reverse proxy of choice must add the security headers.
+
+Please see the deployment section for your reverse proxy of choice.
+

apps/docs/pyproject.toml

@@ -3,7 +3,7 @@ name = "docs"
 version = "0.0.1"
 description = "Documentation for the next generation encrypted file sharing project"
 readme = "README.md"
-requires-python = ">=3.13"
+requires-python = ">=3.14"
 dependencies = ["zensical>=0.0.17"]
 
 [dependency-groups]

apps/docs/uv.lock

@@ -79,6 +79,9 @@ nav = [
         { "Environment" = "cli/environment.md" },
         { "License" = "cli/license.md" },
     ] },
+    { "Upgrade Guides" = [
+        { "v0.1.0" = 'upgrade-guides/v0.1.0.md' },
+    ] },
     { "Transparency" = [
         { "AI" = "transparency/ai.md" },
     ] },