Add sidebar labels to documentation files for improved navigation

m-brtn · m-brtn · commit 5887efaafd67 · 2025-10-24T00:41:07.000+03:00
- Introduced sidebar labels for various SDK guides and API reference documents to enhance user experience and navigation.
- Updated titles and descriptions to provide clearer context for each section within the Vaiz Python SDK documentation.
diff --git a/docs-site/docs/api-reference/boards.md b/docs-site/docs/api-reference/boards.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 6
+sidebar_label: Boards
 title: Boards API — Manage Boards, Groups & Types | Vaiz Python SDK
 description: Learn how to use the Vaiz Python SDK to manage boards, groups, types, and custom fields in your Vaiz workspace. Complete API reference with examples.
 ---
diff --git a/docs-site/docs/api-reference/comments.md b/docs-site/docs/api-reference/comments.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 3
+sidebar_label: Comments
 title: Comments API — Manage Comments, Replies & Reactions | Vaiz Python SDK
 description: Learn how to use the Vaiz Python SDK to manage comments, replies, and reactions in your Vaiz projects. Includes examples, endpoints, and usage patterns.
 ---
diff --git a/docs-site/docs/api-reference/custom-fields.md b/docs-site/docs/api-reference/custom-fields.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 7
+sidebar_label: Custom Fields
 title: Custom Fields API — Manage Board Custom Fields | Vaiz Python SDK
 description: Learn how to use the Vaiz Python SDK to create, edit, and manage custom fields on boards. Supports text, number, date, select, and multi-select fields.
 ---
diff --git a/docs-site/docs/api-reference/document-structure.md b/docs-site/docs/api-reference/document-structure.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 3
+sidebar_label: Document Structure
 title: Document Structure — JSON Format & Block Types | Vaiz Python SDK
 description: Technical reference for the Vaiz document structure JSON format. Learn about blocks, marks, paragraphs, headings, lists, tables, and rich-text formatting.
 ---
diff --git a/docs-site/docs/api-reference/documents.md b/docs-site/docs/api-reference/documents.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 9
+sidebar_label: Documents
 title: Documents API — Create & Edit Rich Documents | Vaiz Python SDK
 description: Learn how to use the Vaiz Python SDK to create, edit, and manage rich-text documents with structured content. Includes JSON format, blocks, and formatting.
 ---
diff --git a/docs-site/docs/api-reference/enums.md b/docs-site/docs/api-reference/enums.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 11
+sidebar_label: Enums
 title: Enums — Task Priority, Avatar Mode & More | Vaiz Python SDK
 description: Complete reference for all enum types and values in the Vaiz Python SDK. Includes TaskPriority, AvatarMode, and other enumeration types.
 ---
diff --git a/docs-site/docs/api-reference/files.md b/docs-site/docs/api-reference/files.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 4
+sidebar_label: Files
 title: Files API — Upload & Manage Files | Vaiz Python SDK
 description: Learn how to use the Vaiz Python SDK to upload files, manage attachments, and work with external URLs. Supports images, videos, PDFs, and more.
 ---
diff --git a/docs-site/docs/api-reference/history.md b/docs-site/docs/api-reference/history.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 10
+sidebar_label: History
 title: History API — Track Document & Task Changes | Vaiz Python SDK
 description: Learn how to use the Vaiz Python SDK to retrieve change history for documents and tasks. Track edits, authors, timestamps, and more.
 ---
diff --git a/docs-site/docs/api-reference/members.md b/docs-site/docs/api-reference/members.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 10
+sidebar_label: Members
 title: Members API — Retrieve Team Members & User Info | Vaiz Python SDK
 description: Learn how to use the Vaiz Python SDK to retrieve space members, user information, and team details. Complete API reference with examples.
 ---
diff --git a/docs-site/docs/api-reference/milestones.md b/docs-site/docs/api-reference/milestones.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 5
+sidebar_label: Milestones
 title: Milestones API — Create & Track Project Milestones | Vaiz Python SDK
 description: Learn how to use the Vaiz Python SDK to create, edit, toggle, and track milestones in your Vaiz projects. Complete API reference with examples.
 ---
diff --git a/docs-site/docs/api-reference/overview.md b/docs-site/docs/api-reference/overview.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+sidebar_label: Overview
 title: API Reference Overview — Complete SDK Documentation | Vaiz Python SDK
 description: Complete API reference documentation for all Vaiz Python SDK methods, models, and enums. Access tasks, documents, boards, comments, files, and more.
 ---
diff --git a/docs-site/docs/api-reference/profile.md b/docs-site/docs/api-reference/profile.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 8
+sidebar_label: Profile
 title: Profile API — Get Current User Profile | Vaiz Python SDK
 description: Learn how to use the Vaiz Python SDK to retrieve the authenticated user's profile information, including name, email, and avatar settings.
 ---
diff --git a/docs-site/docs/api-reference/projects.md b/docs-site/docs/api-reference/projects.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 7
+sidebar_label: Projects
 title: Projects API — Manage Projects & Lists | Vaiz Python SDK
 description: Learn how to use the Vaiz Python SDK to retrieve projects, lists, and organize your workspace structure. Complete API reference with examples.
 ---
diff --git a/docs-site/docs/api-reference/spaces.md b/docs-site/docs/api-reference/spaces.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 11
+sidebar_label: Spaces
 title: Spaces API — Retrieve Workspace & Space Info | Vaiz Python SDK
 description: Learn how to use the Vaiz Python SDK to retrieve space information, settings, and workspace details. Complete API reference with examples.
 ---
diff --git a/docs-site/docs/api-reference/tasks.md b/docs-site/docs/api-reference/tasks.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+sidebar_label: Tasks
 title: Tasks API — Create, Edit & Manage Tasks | Vaiz Python SDK
 description: Learn how to use the Vaiz Python SDK to create, edit, and manage tasks in your Vaiz projects. Includes custom fields, priorities, assignees, and file attachments.
 ---
diff --git a/docs-site/docs/getting-started.md b/docs-site/docs/getting-started.md
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 2
 slug: /
+sidebar_label: Getting Started
 title: Getting Started — Installation & Setup | Vaiz Python SDK
 description: Learn how to install and configure the Vaiz Python SDK. Quick start guide with installation instructions, authentication setup, and your first API call.
 ---
diff --git a/docs-site/docs/guides/basics.md b/docs-site/docs/guides/basics.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+sidebar_label: SDK Basics
 title: SDK Basics — Setup & Core Concepts | Vaiz Python SDK
 description: Learn the basics of the Vaiz Python SDK including client initialization, authentication, error handling, and core concepts for working with tasks and documents.
 ---
diff --git a/docs-site/docs/guides/blockers.md b/docs-site/docs/guides/blockers.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 11
+sidebar_label: Task Blockers
 title: Working with Task Blockers — Dependencies & Relationships | Vaiz Python SDK
 description: Learn how to manage blocking relationships and dependencies between tasks using the Vaiz Python SDK. Create and track task blockers.
 ---
diff --git a/docs-site/docs/guides/boards.md b/docs-site/docs/guides/boards.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 6
+sidebar_label: Boards
 title: Working with Boards — Types, Groups & Fields | Vaiz Python SDK
 description: Learn how to manage boards, create types and groups, and configure custom fields using the Vaiz Python SDK. Complete guide with examples.
 ---
diff --git a/docs-site/docs/guides/comments.md b/docs-site/docs/guides/comments.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 3
+sidebar_label: Comments
 title: Working with Comments — Post, Reply & React | Vaiz Python SDK
 description: Learn how to create comments, replies, and manage reactions in your Vaiz projects using the Python SDK. Includes HTML formatting and file attachments.
 ---
diff --git a/docs-site/docs/guides/custom-fields.md b/docs-site/docs/guides/custom-fields.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 7
+sidebar_label: Custom Fields
 title: Working with Custom Fields — Text, Numbers, Dates & More | Vaiz Python SDK
 description: Learn how to create and manage custom fields on tasks using the Vaiz Python SDK. Supports text, number, date, select, and multi-select field types.
 ---
diff --git a/docs-site/docs/guides/document-structure-helpers.md b/docs-site/docs/guides/document-structure-helpers.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 16
+sidebar_label: Document Structure Helpers
 title: Document Structure Helpers — Type-Safe Content Building | Vaiz Python SDK
 description: Learn how to use type-safe helper functions to build valid document content with the Vaiz Python SDK. Includes paragraphs, headings, lists, tables, and more.
 ---
diff --git a/docs-site/docs/guides/documents.md b/docs-site/docs/guides/documents.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 9
+sidebar_label: Documents
 title: Working with Documents — Rich Content & Formatting | Vaiz Python SDK
 description: Learn how to create and manage rich-text documents in Vaiz using the Python SDK. Includes JSON format, blocks, tables, mentions, and formatting.
 ---
diff --git a/docs-site/docs/guides/files.md b/docs-site/docs/guides/files.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 4
+sidebar_label: Files
 title: Working with Files — Upload & Attach Files | Vaiz Python SDK
 description: Learn how to upload and manage files in Vaiz using the Python SDK. Supports local files, URLs, images, videos, PDFs, and attachments to tasks and comments.
 ---
diff --git a/docs-site/docs/guides/helpers.md b/docs-site/docs/guides/helpers.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 12
+sidebar_label: Helper Functions
 title: Helper Functions — Simplify Common Operations | Vaiz Python SDK
 description: Learn how to use built-in helper functions for custom fields, document formatting, and common operations in the Vaiz Python SDK.
 ---
diff --git a/docs-site/docs/guides/history.md b/docs-site/docs/guides/history.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 10
+sidebar_label: History Events
 title: Working with History — Track Changes & Events | Vaiz Python SDK
 description: Learn how to retrieve and track change history for tasks and documents using the Vaiz Python SDK. Monitor edits, authors, timestamps, and activity logs.
 ---
diff --git a/docs-site/docs/guides/members.md b/docs-site/docs/guides/members.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 10
+sidebar_label: Members
 title: Working with Members — Team & User Information | Vaiz Python SDK
 description: Learn how to retrieve space members, user information, and team details using the Vaiz Python SDK. Complete guide with examples.
 ---
diff --git a/docs-site/docs/guides/milestones.md b/docs-site/docs/guides/milestones.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 5
+sidebar_label: Milestones
 title: Working with Milestones — Track Project Progress | Vaiz Python SDK
 description: Learn how to create, edit, and manage milestones in your Vaiz projects using the Python SDK. Track progress, set dates, and organize your workflow.
 ---
diff --git a/docs-site/docs/guides/profile.md b/docs-site/docs/guides/profile.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 8
+sidebar_label: Profile
 title: Working with Profile — User Info & Settings | Vaiz Python SDK
 description: Learn how to retrieve the authenticated user's profile information using the Vaiz Python SDK. Get name, email, avatar, and account settings.
 ---
diff --git a/docs-site/docs/guides/projects.md b/docs-site/docs/guides/projects.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 7
+sidebar_label: Projects
 title: Working with Projects — Organize Your Workspace | Vaiz Python SDK
 description: Learn how to retrieve and manage projects and lists in your Vaiz workspace using the Python SDK. Complete guide with examples.
 ---
diff --git a/docs-site/docs/guides/spaces.md b/docs-site/docs/guides/spaces.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 9
+sidebar_label: Spaces
 title: Working with Spaces — Workspace Information | Vaiz Python SDK
 description: Learn how to retrieve space information, settings, and workspace details using the Vaiz Python SDK. Complete guide with examples.
 ---
diff --git a/docs-site/docs/guides/tasks.md b/docs-site/docs/guides/tasks.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+sidebar_label: Tasks
 title: Working with Tasks — Complete Guide | Vaiz Python SDK
 description: Learn how to create, edit, and manage tasks using the Vaiz Python SDK. Includes custom fields, file attachments, priorities, assignees, and rich-text descriptions.
 ---
diff --git a/docs-site/docs/intro.md b/docs-site/docs/intro.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+sidebar_label: Introduction
 title: Introduction — Official Python SDK for Vaiz Platform | Vaiz Python SDK
 description: Welcome to the Vaiz Python SDK documentation. Learn about the official Python library for Vaiz platform API with full type support, validation, and rich content management.
 ---
diff --git a/docs-site/docs/patterns/common-patterns.md b/docs-site/docs/patterns/common-patterns.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 3
+sidebar_label: Common Patterns
 title: Common Patterns — Essential SDK Usage Patterns | Vaiz Python SDK
 description: Learn essential patterns for everyday Vaiz Python SDK usage. Includes typed objects, helpers, async operations, and best practices.
 ---
diff --git a/docs-site/docs/patterns/documents.md b/docs-site/docs/patterns/documents.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 4
+sidebar_label: Working with Documents
 title: Document Patterns — Management & Hierarchies | Vaiz Python SDK
 description: Learn patterns for document management and hierarchies in the Vaiz Python SDK. Includes mentions, nested content, and document organization strategies.
 ---
diff --git a/docs-site/docs/patterns/environment-setup.md b/docs-site/docs/patterns/environment-setup.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+sidebar_label: Environment Setup
 title: Environment Setup — Configuration & Best Practices | Vaiz Python SDK
 description: Learn how to configure your development environment for the Vaiz Python SDK. Includes environment variables, credentials, and security best practices.
 ---
diff --git a/docs-site/docs/patterns/error-handling.md b/docs-site/docs/patterns/error-handling.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 8
+sidebar_label: Error Handling
 title: Error Handling — Robust Production Strategies | Vaiz Python SDK
 description: Learn robust error handling strategies for production applications using the Vaiz Python SDK. Includes retry logic, validation, and exception handling.
 ---
diff --git a/docs-site/docs/patterns/integrations.md b/docs-site/docs/patterns/integrations.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 7
+sidebar_label: Integration Patterns
 title: Integration Patterns — Connect External Systems | Vaiz Python SDK
 description: Learn how to integrate the Vaiz Python SDK with external systems and services. Includes webhooks, APIs, databases, and automation patterns.
 ---
diff --git a/docs-site/docs/patterns/introduction.md b/docs-site/docs/patterns/introduction.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+sidebar_label: Introduction
 title: Patterns & Examples — Best Practices | Vaiz Python SDK
 description: Practical examples, design patterns, and best practices for using the Vaiz Python SDK effectively. Learn common patterns and real-world use cases.
 ---
diff --git a/docs-site/docs/patterns/performance.md b/docs-site/docs/patterns/performance.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 6
+sidebar_label: Performance Tips
 title: Performance Tips — Optimize SDK Usage | Vaiz Python SDK
 description: Learn how to optimize your Vaiz Python SDK usage for better performance. Includes batch operations, caching strategies, and efficiency tips.
 ---
diff --git a/docs-site/docs/patterns/ready-to-run.md b/docs-site/docs/patterns/ready-to-run.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 9
+sidebar_label: Ready-to-Run Examples
 title: Ready-to-Run Examples — Complete Code Samples | Vaiz Python SDK
 description: Browse complete, runnable code examples from the Vaiz Python SDK repository. Copy and adapt examples for tasks, documents, boards, comments, and more.
 ---
diff --git a/docs-site/docs/patterns/real-world.md b/docs-site/docs/patterns/real-world.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 5
+sidebar_label: Real-World Scenarios
 title: Real-World Scenarios — Complete Use Cases | Vaiz Python SDK
 description: Explore complete examples for common real-world use cases with the Vaiz Python SDK. Includes automation, integrations, and production workflows.
 ---
diff --git a/docs-site/src/theme/DocItem/Metadata/index.tsx b/docs-site/src/theme/DocItem/Metadata/index.tsx
@@ -0,0 +1,64 @@
+import React from 'react';
+import { useDoc } from '@docusaurus/plugin-content-docs/client';
+import Head from '@docusaurus/Head';
+
+export default function DocItemMetadata(): JSX.Element {
+  const { metadata, frontMatter } = useDoc();
+  const { permalink, title, description } = metadata;
+
+  // Skip if no title or description
+  if (!title || !description) {
+    return null;
+  }
+
+  // Determine proficiency level based on path
+  let proficiencyLevel = 'Intermediate';
+  if (permalink.includes('/getting-started') || permalink === '/') {
+    proficiencyLevel = 'Beginner';
+  } else if (permalink.includes('/api-reference/')) {
+    proficiencyLevel = 'Advanced';
+  } else if (permalink.includes('/guides/basics')) {
+    proficiencyLevel = 'Beginner';
+  } else if (permalink.includes('/patterns/')) {
+    proficiencyLevel = 'Intermediate';
+  }
+
+  // Clean title (remove " | Vaiz Python SDK" suffix if present)
+  const cleanTitle = title.replace(/ \| Vaiz Python SDK$/g, '').trim();
+
+  // Create structured data
+  const structuredData = {
+    '@context': 'https://schema.org',
+    '@type': 'TechArticle',
+    headline: cleanTitle,
+    description: description,
+    proficiencyLevel: proficiencyLevel,
+    programmingLanguage: 'Python',
+    mainEntityOfPage: `https://docs-python-sdk.vaiz.com${permalink}`,
+    creator: {
+      '@type': 'Organization',
+      name: 'Vaiz',
+      url: 'https://vaiz.com',
+    },
+    datePublished: '2024-01-01',
+    dateModified: new Date().toISOString().split('T')[0],
+    inLanguage: 'en',
+    about: {
+      '@type': 'SoftwareSourceCode',
+      name: 'Vaiz Python SDK',
+      programmingLanguage: 'Python',
+      codeRepository: 'https://github.com/vaizcom/vaiz-python-sdk',
+    },
+  };
+
+  return (
+    <Head>
+      <title>{title}</title>
+      <meta property="og:title" content={title} />
+      <script type="application/ld+json">
+        {JSON.stringify(structuredData)}
+      </script>
+    </Head>
+  );
+}
+
