diff --git a/docs/bridge/README.md b/docs/bridge/README.md index 444da6c78f..0c674eeb96 100644 --- a/docs/bridge/README.md +++ b/docs/bridge/README.md @@ -1,6 +1,6 @@ -# Website +# Synapse Bridge Docs -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. +Note, because of [this](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/580#issuecomment-2103047228) issue, docs currently live outside of the yarn workspace. This will be fixed in a future version. ## Generating API Docs diff --git a/docs/bridge/package.json b/docs/bridge/package.json index f0d563a1ae..5eff8c237d 100644 --- a/docs/bridge/package.json +++ b/docs/bridge/package.json @@ -1,5 +1,5 @@ { - "name": "bridge", + "name": "@synapsecns/bridge-docs", "version": "0.0.0", "private": true, "scripts": { @@ -19,8 +19,8 @@ "@docusaurus/preset-classic": "3.2.1", "@mdx-js/react": "^3.0.0", "clsx": "^2.0.0", - "docusaurus-plugin-openapi-docs": "^3.0.0", - "docusaurus-theme-openapi-docs": "^3.0.0", + "docusaurus-plugin-openapi-docs": "3.0.0-beta.10", + "docusaurus-theme-openapi-docs": "3.0.0-beta.10", "prism-react-renderer": "^2.3.0", "react": "^18.0.0", "react-dom": "^18.0.0" diff --git a/docs/bridge/yarn.lock b/docs/bridge/yarn.lock index 1ec1c56b2d..15357747b8 100644 --- a/docs/bridge/yarn.lock +++ b/docs/bridge/yarn.lock @@ -4073,7 +4073,7 @@ dns-packet@^5.2.2: dependencies: "@leichtgewicht/ip-codec" "^2.0.1" -docusaurus-plugin-openapi-docs@^3.0.0, docusaurus-plugin-openapi-docs@^3.0.0-beta.10: +docusaurus-plugin-openapi-docs@3.0.0-beta.10, docusaurus-plugin-openapi-docs@^3.0.0-beta.10: version "3.0.0-beta.10" resolved "https://registry.yarnpkg.com/docusaurus-plugin-openapi-docs/-/docusaurus-plugin-openapi-docs-3.0.0-beta.10.tgz#f0c303ee852487c852c163d019678a92b53abf81" integrity sha512-BtMBH4TzCiMM0WbO2ZAMXSuL7Ge9yyASZhAycb5vX+KSUnUgp47/Ex2f6/evBfaadnr6vXYEr1UBT1fSiJYh5w== @@ -4104,7 +4104,7 @@ docusaurus-plugin-sass@^0.2.3: dependencies: sass-loader "^10.1.1" -docusaurus-theme-openapi-docs@^3.0.0: +docusaurus-theme-openapi-docs@3.0.0-beta.10: version "3.0.0-beta.10" resolved "https://registry.yarnpkg.com/docusaurus-theme-openapi-docs/-/docusaurus-theme-openapi-docs-3.0.0-beta.10.tgz#f9a790b1ef88ff01f266224064f4b2f80d0892ff" integrity sha512-8oUMMZSrRJ9EssrjWwbM9aYuHOt1AAm6wQDzWr8k6VvefGvVAibg4Y9PK7GeZ243lJikq9s45KqUA0SMwsm+Fg==