From 73ea44e0a2314211225a9cfea8c8fdfdad16084b Mon Sep 17 00:00:00 2001 From: Mattias Buelens Date: Wed, 13 Mar 2024 18:02:06 +0100 Subject: [PATCH 1/4] Migrate examples for Open Video UI for React --- open-video-ui/external/web-ui | 2 +- sidebarsOpenVideoUI.ts | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/open-video-ui/external/web-ui b/open-video-ui/external/web-ui index e3b03ea1a86..159d66d527c 160000 --- a/open-video-ui/external/web-ui +++ b/open-video-ui/external/web-ui @@ -1 +1 @@ -Subproject commit e3b03ea1a86d699c0888e1b40803af1e308d74ed +Subproject commit 159d66d527c38d9770acc53955ea1a9bb3d24c34 diff --git a/sidebarsOpenVideoUI.ts b/sidebarsOpenVideoUI.ts index a3ec650adf1..21346a6603a 100644 --- a/sidebarsOpenVideoUI.ts +++ b/sidebarsOpenVideoUI.ts @@ -69,6 +69,12 @@ const sidebars: SidebarsConfig = { // { type: 'autogenerated', dirName: 'external/web-ui/docs/guides' } ], }, + { + type: 'category', + label: 'Examples', + link: { type: 'generated-index', slug: 'react/examples' }, + items: [{ type: 'autogenerated', dirName: 'external/web-ui/docs/react/examples' }], + }, { type: 'doc', id: 'external/web-ui/react/CHANGELOG' }, { type: 'link', From c25072e1ba64db1c8a54bb05d7884770cd9715ed Mon Sep 17 00:00:00 2001 From: Mattias Buelens Date: Wed, 13 Mar 2024 18:55:10 +0100 Subject: [PATCH 2/4] Add Getting started guides for Web and React --- docusaurus.config.ts | 4 ++-- open-video-ui/external/web-ui | 2 +- open-video-ui/react/getting-started.mdx | 9 --------- open-video-ui/web/getting-started.mdx | 9 --------- sidebarsOpenVideoUI.ts | 4 ++-- 5 files changed, 5 insertions(+), 23 deletions(-) delete mode 100644 open-video-ui/react/getting-started.mdx delete mode 100644 open-video-ui/web/getting-started.mdx diff --git a/docusaurus.config.ts b/docusaurus.config.ts index fe7b0490138..87abf0083c6 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -97,7 +97,7 @@ const config: Config = { v4: { label: fs.readFileSync(path.join(__dirname, 'theoplayer_versioned_docs/version-v4/version.txt'), 'utf8').trim(), banner: 'unmaintained', - noIndex: true + noIndex: true, }, }, } satisfies DocsPlugin.Options, @@ -299,7 +299,7 @@ const config: Config = { prism: { theme: prismThemes.github, darkTheme: prismThemes.dracula, - additionalLanguages: ['java', 'groovy', 'objectivec', 'brightscript'], + additionalLanguages: ['java', 'groovy', 'objectivec', 'brightscript', 'bash'], }, } satisfies Preset.ThemeConfig, }; diff --git a/open-video-ui/external/web-ui b/open-video-ui/external/web-ui index 159d66d527c..fe8ab8dff15 160000 --- a/open-video-ui/external/web-ui +++ b/open-video-ui/external/web-ui @@ -1 +1 @@ -Subproject commit 159d66d527c38d9770acc53955ea1a9bb3d24c34 +Subproject commit fe8ab8dff157a76184b01de889eca86f55b2dbca diff --git a/open-video-ui/react/getting-started.mdx b/open-video-ui/react/getting-started.mdx deleted file mode 100644 index f248c3f8a3f..00000000000 --- a/open-video-ui/react/getting-started.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Getting started - -1. `npm install @theoplayer/react-ui` -2. ??? -3. Profit! diff --git a/open-video-ui/web/getting-started.mdx b/open-video-ui/web/getting-started.mdx deleted file mode 100644 index 51aab575d78..00000000000 --- a/open-video-ui/web/getting-started.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Getting started - -1. `npm install @theoplayer/web-ui` -2. ??? -3. Profit! diff --git a/sidebarsOpenVideoUI.ts b/sidebarsOpenVideoUI.ts index 21346a6603a..7bb03e4e0e1 100644 --- a/sidebarsOpenVideoUI.ts +++ b/sidebarsOpenVideoUI.ts @@ -26,7 +26,7 @@ const sidebars: SidebarsConfig = { title: 'Open Video UI for Web', }, items: [ - { type: 'doc', id: 'web/getting-started' }, + { type: 'doc', id: 'external/web-ui/docs/getting-started' }, { type: 'category', label: 'How-to guides', @@ -60,7 +60,7 @@ const sidebars: SidebarsConfig = { title: 'Open Video UI for React', }, items: [ - { type: 'doc', id: 'react/getting-started' }, + { type: 'doc', id: 'external/web-ui/docs/react/getting-started' }, { type: 'category', label: 'How-to guides', From 6704a1f0a795f7d5448a2fc22da27d64a7b7231a Mon Sep 17 00:00:00 2001 From: Mattias Buelens Date: Wed, 13 Mar 2024 18:55:33 +0100 Subject: [PATCH 3/4] Add descriptions and icons --- open-video-ui/android/getting-started.mdx | 2 ++ open-video-ui/external/web-ui | 2 +- sidebarsOpenVideoUI.ts | 32 +++++++++++++++++++++++ 3 files changed, 35 insertions(+), 1 deletion(-) diff --git a/open-video-ui/android/getting-started.mdx b/open-video-ui/android/getting-started.mdx index 7e6ca7c8a2d..52eac221329 100644 --- a/open-video-ui/android/getting-started.mdx +++ b/open-video-ui/android/getting-started.mdx @@ -1,5 +1,7 @@ --- +description: Start building your UI in just a few minutes! sidebar_position: 1 +sidebar_custom_props: { 'icon': '🚀' } --- # Getting started diff --git a/open-video-ui/external/web-ui b/open-video-ui/external/web-ui index fe8ab8dff15..6265236c3a3 160000 --- a/open-video-ui/external/web-ui +++ b/open-video-ui/external/web-ui @@ -1 +1 @@ -Subproject commit fe8ab8dff157a76184b01de889eca86f55b2dbca +Subproject commit 6265236c3a373aa16f35e01e759b2960b8627421 diff --git a/sidebarsOpenVideoUI.ts b/sidebarsOpenVideoUI.ts index 7bb03e4e0e1..4d15db306ca 100644 --- a/sidebarsOpenVideoUI.ts +++ b/sidebarsOpenVideoUI.ts @@ -30,12 +30,20 @@ const sidebars: SidebarsConfig = { { type: 'category', label: 'How-to guides', + description: 'Learn how to integrate our rich set of features into your own UI.', + customProps: { + icon: '📖', + }, link: { type: 'generated-index', slug: 'web/guides' }, items: [{ type: 'autogenerated', dirName: 'external/web-ui/docs/guides' }], }, { type: 'category', label: 'Examples', + description: 'Find inspiration for your UI from our live demos!', + customProps: { + icon: '🛝', + }, link: { type: 'generated-index', slug: 'web/examples' }, items: [{ type: 'autogenerated', dirName: 'external/web-ui/docs/examples' }], }, @@ -43,6 +51,10 @@ const sidebars: SidebarsConfig = { { type: 'link', label: 'API reference', + description: 'Discover all components provided by Open Video UI for Web.', + customProps: { + icon: '*️⃣', + }, href: 'https://theoplayer.github.io/web-ui/api/', }, ], @@ -64,6 +76,10 @@ const sidebars: SidebarsConfig = { { type: 'category', label: 'How-to guides', + description: 'Learn how to integrate our rich set of features into your own UI.', + customProps: { + icon: '📖', + }, link: { type: 'generated-index', slug: 'react/guides' }, items: [ // { type: 'autogenerated', dirName: 'external/web-ui/docs/guides' } @@ -72,6 +88,10 @@ const sidebars: SidebarsConfig = { { type: 'category', label: 'Examples', + description: 'Find inspiration for your UI from our live demos!', + customProps: { + icon: '🛝', + }, link: { type: 'generated-index', slug: 'react/examples' }, items: [{ type: 'autogenerated', dirName: 'external/web-ui/docs/react/examples' }], }, @@ -79,6 +99,10 @@ const sidebars: SidebarsConfig = { { type: 'link', label: 'API reference', + description: 'Discover all components and hooks provided by Open Video UI for React.', + customProps: { + icon: '*️⃣', + }, href: 'https://theoplayer.github.io/web-ui/react-api/', }, ], @@ -100,6 +124,10 @@ const sidebars: SidebarsConfig = { { type: 'category', label: 'How-to guides', + description: 'Learn how to integrate our rich set of features into your own UI.', + customProps: { + icon: '📖', + }, link: { type: 'generated-index', slug: 'android/guides' }, items: [{ type: 'autogenerated', dirName: 'external/android-ui/docs/guides' }], }, @@ -107,6 +135,10 @@ const sidebars: SidebarsConfig = { { type: 'link', label: 'API reference', + description: 'Discover all components provided by Open Video UI for Android.', + customProps: { + icon: '*️⃣', + }, href: 'https://theoplayer.github.io/android-ui/api/', }, ], From 813fb71018b8e29ba6439bb1e8604f576fa5d9e2 Mon Sep 17 00:00:00 2001 From: Mattias Buelens Date: Mon, 18 Mar 2024 13:14:24 +0100 Subject: [PATCH 4/4] Update web-ui --- open-video-ui/external/web-ui | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/open-video-ui/external/web-ui b/open-video-ui/external/web-ui index 6265236c3a3..4660a0ae925 160000 --- a/open-video-ui/external/web-ui +++ b/open-video-ui/external/web-ui @@ -1 +1 @@ -Subproject commit 6265236c3a373aa16f35e01e759b2960b8627421 +Subproject commit 4660a0ae9253b4f086c3f5964bf4b522b8520c47