Add category descriptions

THEOplayer · Mar 6, 2024 · 80cc958 · 80cc958
1 parent e523300
commit 80cc958
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 9 deletions.
diff --git a/sidebarsOpenVideoUI.ts b/sidebarsOpenVideoUI.ts
@@ -16,7 +16,15 @@ const sidebars: SidebarsConfig = {
     {
       type: 'category',
       label: 'Web',
-      link: { type: 'generated-index', slug: 'web' },
+      description: 'Build an astonishing player UI with Web Components.',
+      customProps: {
+        icon: '🌐',
+      },
+      link: {
+        type: 'generated-index',
+        slug: 'web',
+        title: 'Open Video UI for Web',
+      },
       items: [
         { type: 'doc', id: 'web/getting-started' },
         {
@@ -42,7 +50,15 @@ const sidebars: SidebarsConfig = {
     {
       type: 'category',
       label: 'React',
-      link: { type: 'generated-index', slug: 'react' },
+      description: 'Build a stunning player UI with React components.',
+      customProps: {
+        icon: '⚛️',
+      },
+      link: {
+        type: 'generated-index',
+        slug: 'react',
+        title: 'Open Video UI for React',
+      },
       items: [
         { type: 'doc', id: 'react/getting-started' },
         {
@@ -64,7 +80,15 @@ const sidebars: SidebarsConfig = {
     {
       type: 'category',
       label: 'Android',
-      link: { type: 'generated-index', slug: 'android' },
+      description: 'Build a mobile-first player UI for Android with Jetpack Compose.',
+      customProps: {
+        icon: '🤖',
+      },
+      link: {
+        type: 'generated-index',
+        slug: 'android',
+        title: 'Open Video UI for Android',
+      },
       items: [
         { type: 'doc', id: 'android/getting-started' },
         {

diff --git a/sidebarsTheoplayer.ts b/sidebarsTheoplayer.ts
@@ -16,31 +16,41 @@ const sidebars: SidebarsConfig = {
     {
       type: 'category',
       label: 'Getting started',
+      description: 'Set up your first THEOplayer in just a few minutes!',
+      customProps: {
+        icon: '🚀',
+      },
       link: { type: 'doc', id: 'getting-started/index' },
       items: [{ type: 'autogenerated', dirName: 'getting-started' }],
     },
     {
       type: 'category',
       label: 'Guides',
+      description: 'Learn how to implement our rich set of features and integrations.',
+      customProps: {
+        icon: '📖',
+      },
       link: { type: 'generated-index', slug: 'guides' },
       items: [{ type: 'autogenerated', dirName: 'guides' }],
     },
-    {
-      type: 'category',
-      label: 'FAQ',
-      link: { type: 'doc', id: 'faq/index' },
-      items: [{ type: 'autogenerated', dirName: 'faq' }],
-    },
     {
       type: 'category',
       label: 'Examples',
+      description: 'See the player in action!',
+      customProps: {
+        icon: '🛝',
+      },
       link: { type: 'generated-index', slug: 'examples' },
       items: [{ type: 'autogenerated', dirName: 'examples' }],
     },
     'changelog',
     {
       type: 'category',
       label: 'API references',
+      description: 'Discover all properties and functions of THEOplayer.',
+      customProps: {
+        icon: '*️⃣',
+      },
       link: { type: 'generated-index', slug: 'api' },
       items: [
         {