FA-597: v1.1 release updates (#30)

This commit provides the updates to the documentation for v1.1, including
making the docs multi-version aware:

* Upgrade docusaurus to v3.4
* Versioning prep: split into `manual` and `info` subsites
* Support multi-versioning
* Minor proofreading on getting started
* Add v1.1.0 release notes, download links
* v1.1 content updates
* Update screenshots
* Update known-issues
* Issue v1.1.0 version

docusaurus.config.js

@@ -16,7 +16,6 @@ module.exports = {
   favicon: "img/favicon.ico",
   organizationName: "fourieraudio", // Usually your GitHub org/user name.
   projectName: "docs", // Usually your repo name.
-  plugins: [require.resolve("docusaurus-lunr-search")],
   themes: ["@docusaurus/theme-mermaid"],
   themeConfig: {
     colorMode: {
@@ -40,23 +39,18 @@ module.exports = {
       },
       items: [
         {
-          type: "doc",
-          docId: "support",
+          type: "docSidebar",
+          sidebarId: "sidebars",
           position: "left",
-          label: "Support",
+          label: "Support & Downloads",
+          docsPluginId: "info",
         },
         {
-          type: "doc",
-          docId: "manual/manual",
+          type: "docSidebar",
+          sidebarId: "sidebars",
           position: "left",
           label: "User Manual",
         },
-        {
-          type: "doc",
-          docId: "downloads/index",
-          position: "left",
-          label: "Downloads",
-        },
         {
           label: "Forum",
           href: "https://discourse.fourieraudio.com",
@@ -65,6 +59,13 @@ module.exports = {
           label: "Website",
           href: "https://www.fourieraudio.com",
         },
+        {
+          type: "docsVersionDropdown",
+          position: "right",
+          dropdownItemsAfter: [
+            {to: '/downloads', label: "All versions"},
+          ],
+        },
       ],
     },
     footer: {
@@ -114,9 +115,11 @@ module.exports = {
       "@docusaurus/preset-classic",
       {
         docs: {
-          routeBasePath: '/',
-          sidebarPath: require.resolve("./sidebars.js"),
-          editUrl: "https://github.com/fourieraudio/docs/blob/main/",
+          path: 'manual',
+          routeBasePath: 'manual',
+          sidebarPath: "./sidebars-manual.js",
+          editUrl: "https://github.com/fourieraudio/docs/blob/main/manual/",
+          includeCurrentVersion: process.env.NODE_ENV === "development",
         },
         blog: false,
         theme: {
@@ -125,4 +128,14 @@ module.exports = {
       },
     ],
   ],
+  plugins: [
+    require.resolve("docusaurus-lunr-search"),
+    ['@docusaurus/plugin-content-docs', {
+      id: 'info',
+      path: 'info',
+      routeBasePath: '/',
+      sidebarPath: './sidebars-info.js',
+      editUrl: "https://github.com/fourieraudio/docs/blob/main/",
+    }]
+  ],
 };

docs/downloads/index.md → info/downloads/index.md

@@ -6,11 +6,11 @@ sidebar_position: 4
 
 Here you can find the latest **transform**.client:
 
-<a class="button button--lg button--primary" href="https://downloads.fourieraudio.com/transform/latest/FourierTransform-Release-1.0.1-win32.exe">Windows</a>
+<a class="button button--lg button--primary" href="https://downloads.fourieraudio.com/transform/latest/FourierTransform-Release-1.1.0-win32.exe">Windows v1.1.0</a>
 <br/><br/>
-<a class="button button--lg button--primary" href="https://downloads.fourieraudio.com/transform/latest/FourierTransform-Release-1.0.1-arm64.zip">macOS (ARM)</a>
+<a class="button button--lg button--primary" href="https://downloads.fourieraudio.com/transform/latest/FourierTransform-Release-1.1.0-arm64.zip">macOS (ARM) v1.1.0</a>
 <br/><br/>
-<a class="button button--lg button--primary" href="https://downloads.fourieraudio.com/transform/latest/FourierTransform-Release-1.0.1-x64.zip">macOS (x86-64)</a>
+<a class="button button--lg button--primary" href="https://downloads.fourieraudio.com/transform/latest/FourierTransform-Release-1.1.0-x64.zip">macOS (x86-64) v1.1.0</a>
 <br/><br/>
 
 :::info
@@ -33,10 +33,11 @@ compatibility ranges at any time.</small>
 
 # Releases
 
-| Engine Version | Compatible Client Version | Release Date | Latest |                      |
-| -------------- | ------------------------- | ------------ | ------ | -------------------- |
-| 1.0.0          | 1.0.0                     | 22/04/2024   |        | [Release notes](v1-0-0.md) |
-| "              | 1.0.1                     | 22/04/2024   | Yes    | [Release notes](v1-0-1.md) |
+| Engine Version | Client Version            | Release Date | Latest  |                      |
+| -------------- | ------------------------- | ------------ | ------- | -------------------- |
+| **1.1.0**      | **1.1.0**                 | 24/06/2024   | **Yes** | [Release notes](v1-1-0.md) |
+|                | 1.0.1                     | 22/04/2024   |         | [Release notes](v1-0-1.md) |
+| 1.0.0          | 1.0.0                     | 22/04/2024   |         | [Release notes](v1-0-0.md) |
 
 :::note
 

docs/downloads/v1-0-0.md → info/downloads/v1-0-0.md

@@ -22,7 +22,7 @@ sidebar_label: Release Notes v1.0.0
 
 ## Known Issues
 
-Users should be aware of the following [known issues](../manual/known-issues.md) in this release, which we hope to address in a future update:
+Users should be aware of the following [known issues](/manual/known-issues) in this release, which we hope to address in a future update:
 
 - TF-944: Dante Secondary interface is only operational when using DHCP or Static IP addressing
 - TF-1345: Chain metering freezes whilst that chain restarts

docs/downloads/v1-0-1.md → info/downloads/v1-0-1.md

@@ -30,7 +30,7 @@ with **transform**.engine `v1.0.0`.
 
 ## Known Issues
 
-Users should be aware of the following [known issues](../manual/known-issues.md) in this release, which we hope to address in a future update:
+Users should be aware of the following [known issues](/manual/known-issues) in this release, which we hope to address in a future update:
 
 - TF-944: Dante Secondary interface is only operational when using DHCP or Static IP addressing
 - TF-1345: Chain metering freezes whilst that chain restarts

info/downloads/v1-1-0.md

@@ -0,0 +1,88 @@
+---
+sidebar_label: Release Notes v1.1.0
+---
+
+# transform.engine v1.1.0 release notes
+
+- **Engine Version**: `1.1.0`
+- **Windows Client Version**: `1.1.0`
+- **macOS Client Version**: `1.1.0`
+
+## Summary
+
+This is a bugfix release, intended to improve general happiness and resolve several critical issues
+you may experience using **transform**.engine.
+
+We strongly encourage all users to update to this fully backwards-compatible release immediately.
+
+## Bugs Fixed In This Release
+
+* TF-1847: Plugin data can fail to save after loading a showfile
+* TF-1686: Connecting the client to the **transform**.engine using a link-local address results in
+  “heartbeat stalled”’; no metering or teleport
+* TF-1696: Certain plugins may lead to incorrectly excessive DSP load being displayed
+* TF-1345: Chain metering freezes whilst that chain restarts
+* TF-1279: Certain plugin controls cannot be used
+* TF-1857: **transform**.client: Some IP addresses could not be input
+* TF-1784, TF-1835, TF-1845, TF-1860: **transform**.client does not always reliably reconnect to
+  engine, leading to “heartbeat stalled” or “cannot submit command to director”
+* TF-1673: System status indicators are occasionally inaccurate
+* TF-1753: Improve plugin loading time, prevent unnecessary reloads if latency has not changed
+* TF-1849: **transform**.client: Prevent crashes in certain pathological cases
+* TF-1718, TF-1752, TF-1787: **transform**.client: Accessibility / keyboard navigation improvements
+* TF-1685, TF-1786: **transform**.client: System status view clipped on small screens
+* TF-1695, TF-1876: **transform**.client: Performance improvements
+* TF-1815: Dante (DEP) upgrade to v1.3.3.5, improving PTP lock reliability, preventing mDNS traffic
+  from leaking onto the control network, and addressing an issue where switching sample rate would
+  result in incorrect latency values in Dante Controller.
+
+## New In This Release
+* TF-1781: Dante network latencies above 2 ms now supported in 32 sample-per-buffer mode
+* TF-1803: **transform**.client: Simplify showfile save operations under “Save Copy” action
+* TF-1809: **transform**.client: Make it really obvious that resetting the plugin host to its
+  factory settings will reset the plugin host to its factory settings
+* TF-1877: Plugin compatibility database update
+* TF-17: Display audio renderer performance statistics
+* TF-1100: **transform**.client: Make scrollbars more obvious
+
+## Compatibility Notes
+Showfiles saved in engine v1.0 can be freely loaded into an engine running v1.1. Once a showfile has
+been loaded in engine v1.1, it cannot be subsequently loaded into an engine running v1.0. We
+apologise for the inconvenience; it is our aim in general for showfiles to be backwards-compatible
+where possible.
+
+**transform**.engine v1.1 is otherwise fully backwards compatible with **transform**.client v1.0, and
+vice-versa; you can connect to an engine running v1.0 from a client running v1.1, and to an engine
+running v1.1 from a client running v1.0.
+
+## Known Issues
+
+Users should be aware of the following [known issues](/manual/known-issues) in this release, which
+we hope to address in a future update:
+
+* TF-944: Dante Secondary interface is only operational when using DHCP or Static IP addressing
+* TF-1891: DSP load meter occasionally jumps to 100%
+* TF-1810: Plugin scanner can stall showing spinner
+
+For more details and workarounds for these issues, see the [known issues list](/manual/known-issues).
+
+A small number of plugins may experience compatibility issues running on transform.engine.
+For details, see our plugin compatibility database at https://plugins.fourieraudio.com .
+
+## Docs, Support & Bug Requests
+
+We would warmly welcome any bug reports you may have on our discussion site:
+https://discourse.fourieraudio.com . We’ll also be happy to chat and answer any questions you may
+have there!
+
+To learn more about how to use transform.engine, please check out our docs at
+https://docs.fourieraudio.com , where you can also find handy walkthrough videos showing how to get
+started.
+
+If you need support with transform.engine, please feel free to reach out to your local dealer or
+distributor, or contact us directly at support@fourieraudio.com .
+
+## Upcoming Release Schedule
+
+We are hoping to release transform.engine v1.2 later this summer. For information on what’s
+coming up, see our product roadmap here: https://go.fourieraudio.com/future .