diff --git a/package-lock.json b/package-lock.json
index 6d4cb7c65..d3ffa2d8d 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -29,7 +29,7 @@
"@eslint/compat": "^1.3.2",
"@faker-js/faker": "^7.6.0",
"@jest/globals": "^29.2.0",
- "@opencollection/types": "~0.6.0",
+ "@opencollection/types": "~0.7.0",
"@playwright/test": "^1.51.1",
"@rollup/plugin-json": "^6.1.0",
"@storybook/addon-webpack5-compiler-babel": "^4.0.0",
@@ -6100,9 +6100,9 @@
}
},
"node_modules/@opencollection/types": {
- "version": "0.6.0",
- "resolved": "https://registry.npmjs.org/@opencollection/types/-/types-0.6.0.tgz",
- "integrity": "sha512-nasB4/1hIZ61xp2dnnZWhdH83f0t800VrSl3G2q+BtHabBqN/IG+j9BMOJg0hYZjAVx+Yhl1njkzUqkiX5+Q0g==",
+ "version": "0.7.0",
+ "resolved": "https://registry.npmjs.org/@opencollection/types/-/types-0.7.0.tgz",
+ "integrity": "sha512-CSwdaHNPa2bNNBAOy++t6W9gBTExUJZW3aPkWyhAjasusThbvjymD/0uCLR50gCXSs0ezv61jsd19m9x+2DMtQ==",
"dev": true,
"license": "MIT"
},
diff --git a/package.json b/package.json
index 01291a27b..b15e02d9d 100644
--- a/package.json
+++ b/package.json
@@ -23,7 +23,7 @@
"@eslint/compat": "^1.3.2",
"@faker-js/faker": "^7.6.0",
"@jest/globals": "^29.2.0",
- "@opencollection/types": "~0.6.0",
+ "@opencollection/types": "~0.7.0",
"@playwright/test": "^1.51.1",
"@rollup/plugin-json": "^6.1.0",
"@storybook/addon-webpack5-compiler-babel": "^4.0.0",
diff --git a/packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/StyledWrapper.js b/packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/StyledWrapper.js
index 6c55d5200..f7ccd063b 100644
--- a/packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/StyledWrapper.js
+++ b/packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/StyledWrapper.js
@@ -13,6 +13,30 @@ const StyledWrapper = styled.div`
line-height: 1.6;
}
+ .preview-container {
+ border-radius: ${(props) => props.theme.border.radius.md};
+ overflow: hidden;
+ border: 1px solid ${(props) => props.theme.border.border1};
+
+ .preview-label {
+ top: 0.5rem;
+ right: 0.5rem;
+ padding: 0.125rem 0.5rem;
+ font-size: ${(props) => props.theme.font.size.xs};
+ font-weight: 500;
+ color: #3b82f6;
+ background-color: rgba(59, 130, 246, 0.1);
+ border: 1px dashed rgba(59, 130, 246, 0.4);
+ border-radius: ${(props) => props.theme.border.radius.sm};
+ }
+
+ .preview-image {
+ width: 100%;
+ height: auto;
+ display: block;
+ }
+ }
+
.features {
li {
font-size: ${(props) => props.theme.font.size.sm};
diff --git a/packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/demo.png b/packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/demo.png
new file mode 100644
index 000000000..bced392e4
Binary files /dev/null and b/packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/demo.png differ
diff --git a/packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/index.js b/packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/index.js
index cb5e883d4..864feb367 100644
--- a/packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/index.js
+++ b/packages/bruno-app/src/components/Sidebar/Collections/Collection/GenerateDocumentation/index.js
@@ -9,6 +9,7 @@ import { IconBook, IconCheck, IconAlertTriangle, IconLoader2 } from '@tabler/ico
import Modal from 'components/Modal';
import StyledWrapper from './StyledWrapper';
+import demoImage from './demo.png';
import { useApp } from 'providers/App';
import { transformCollectionToSaveToExportAsFile, findCollectionByUid, areItemsLoading } from 'utils/collections/index';
import { brunoToOpenCollection } from '@usebruno/converters';
@@ -141,12 +142,16 @@ const GenerateDocumentation = ({ onClose, collectionUid }) => {
- Generate a standalone HTML file containing interactive documentation for your API collection. - This file can be hosted anywhere or shared with your team. +
+ Generate a standalone HTML file that can be hosted anywhere or shared with your team.
-- The generated file does not embed all assets. It loads OpenCollection’s JavaScript and CSS files from a CDN when viewing docs, which requires an internet connection. + The generated file loads OpenCollection's JavaScript and CSS files from a CDN, which requires an internet connection.
)} diff --git a/packages/bruno-app/src/components/Sidebar/CreateCollection/StyledWrapper.js b/packages/bruno-app/src/components/Sidebar/CreateCollection/StyledWrapper.js index 8be5446dd..98fd22b72 100644 --- a/packages/bruno-app/src/components/Sidebar/CreateCollection/StyledWrapper.js +++ b/packages/bruno-app/src/components/Sidebar/CreateCollection/StyledWrapper.js @@ -14,6 +14,18 @@ const StyledWrapper = styled.div` border-radius: ${(props) => props.theme.border.radius.sm}; } + .discussion-link { + margin-left: 0.5rem; + font-size: ${(props) => props.theme.font.size.sm}; + color: ${(props) => props.theme.textLink}; + cursor: pointer; + font-weight: 400; + + &:hover { + text-decoration: underline; + } + } + .report-issue-link { display: inline-flex; align-items: center; diff --git a/packages/bruno-app/src/components/Sidebar/CreateCollection/index.js b/packages/bruno-app/src/components/Sidebar/CreateCollection/index.js index a41542d0e..387a3deac 100644 --- a/packages/bruno-app/src/components/Sidebar/CreateCollection/index.js +++ b/packages/bruno-app/src/components/Sidebar/CreateCollection/index.js @@ -224,7 +224,19 @@ const CreateCollection = ({ onClose, defaultLocation: propDefaultLocation }) => {formik.values.format === 'yml' && ( - Beta + <> + Beta + { + e.preventDefault(); + window.open('https://github.com/usebruno/bruno/discussions/6634', '_blank', 'noopener,noreferrer'); + }} + > + Join the discussion + + > )}