Enhance documentation with titles and descriptions for SDK guides and API references

m-brtn · m-brtn · commit 55f36b9ff45c · 2025-10-24T00:28:40.000+03:00
- Added titles and descriptions to various documentation files to improve clarity and SEO.
- Updated guides and API reference sections to provide better context and usability for users of the Vaiz Python SDK.
diff --git a/docs-site/docs/api-reference/boards.md b/docs-site/docs/api-reference/boards.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 6
+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.
 ---
 
 # Boards
diff --git a/docs-site/docs/api-reference/comments.md b/docs-site/docs/api-reference/comments.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 3
+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.
 ---
 
 # Comments
diff --git a/docs-site/docs/api-reference/custom-fields.md b/docs-site/docs/api-reference/custom-fields.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 7
+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.
 ---
 
 # Custom Fields
diff --git a/docs-site/docs/api-reference/document-structure.md b/docs-site/docs/api-reference/document-structure.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 3
+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.
 ---
 
 # Document Structure
diff --git a/docs-site/docs/api-reference/documents.md b/docs-site/docs/api-reference/documents.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 9
+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.
 ---
 
 # Documents
diff --git a/docs-site/docs/api-reference/enums.md b/docs-site/docs/api-reference/enums.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 11
+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.
 ---
 
 # Enums
diff --git a/docs-site/docs/api-reference/files.md b/docs-site/docs/api-reference/files.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 4
+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.
 ---
 
 # Files
diff --git a/docs-site/docs/api-reference/history.md b/docs-site/docs/api-reference/history.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 10
+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.
 ---
 
 # History
diff --git a/docs-site/docs/api-reference/members.md b/docs-site/docs/api-reference/members.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 10
+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.
 ---
 
 # Members
diff --git a/docs-site/docs/api-reference/milestones.md b/docs-site/docs/api-reference/milestones.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 5
+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.
 ---
 
 # Milestones
diff --git a/docs-site/docs/api-reference/overview.md b/docs-site/docs/api-reference/overview.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 1
+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.
 ---
 
 # Overview
diff --git a/docs-site/docs/api-reference/profile.md b/docs-site/docs/api-reference/profile.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 8
+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.
 ---
 
 # Profile
diff --git a/docs-site/docs/api-reference/projects.md b/docs-site/docs/api-reference/projects.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 7
+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.
 ---
 
 # Projects
diff --git a/docs-site/docs/api-reference/spaces.md b/docs-site/docs/api-reference/spaces.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 11
+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.
 ---
 
 # Spaces
diff --git a/docs-site/docs/api-reference/tasks.md b/docs-site/docs/api-reference/tasks.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 2
+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.
 ---
 
 # Tasks
diff --git a/docs-site/docs/getting-started.md b/docs-site/docs/getting-started.md
@@ -1,6 +1,8 @@
 ---
 sidebar_position: 2
 slug: /
+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.
 ---
 
 # Getting Started
diff --git a/docs-site/docs/guides/basics.md b/docs-site/docs/guides/basics.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 1
+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.
 ---
 
 # Basics
diff --git a/docs-site/docs/guides/blockers.md b/docs-site/docs/guides/blockers.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 11
+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.
 ---
 
 # Task Blockers
diff --git a/docs-site/docs/guides/boards.md b/docs-site/docs/guides/boards.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 6
+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.
 ---
 
 # Boards
diff --git a/docs-site/docs/guides/comments.md b/docs-site/docs/guides/comments.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 3
+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.
 ---
 
 # Comments
diff --git a/docs-site/docs/guides/custom-fields.md b/docs-site/docs/guides/custom-fields.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 7
+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.
 ---
 
 # Custom Fields
diff --git a/docs-site/docs/guides/document-structure-helpers.md b/docs-site/docs/guides/document-structure-helpers.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 16
+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.
 ---
 
 # Document Structure Helpers
diff --git a/docs-site/docs/guides/documents.md b/docs-site/docs/guides/documents.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 9
+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.
 ---
 
 # Documents
diff --git a/docs-site/docs/guides/files.md b/docs-site/docs/guides/files.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 4
+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.
 ---
 
 # Files
diff --git a/docs-site/docs/guides/helpers.md b/docs-site/docs/guides/helpers.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 12
+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.
 ---
 
 # Helper Functions
diff --git a/docs-site/docs/guides/history.md b/docs-site/docs/guides/history.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 10
+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.
 ---
 
 # History Events
diff --git a/docs-site/docs/guides/members.md b/docs-site/docs/guides/members.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 10
+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.
 ---
 
 # Members
diff --git a/docs-site/docs/guides/milestones.md b/docs-site/docs/guides/milestones.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 5
+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.
 ---
 
 # Milestones
diff --git a/docs-site/docs/guides/profile.md b/docs-site/docs/guides/profile.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 8
+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.
 ---
 
 # Profile
diff --git a/docs-site/docs/guides/projects.md b/docs-site/docs/guides/projects.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 7
+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.
 ---
 
 # Projects
diff --git a/docs-site/docs/guides/spaces.md b/docs-site/docs/guides/spaces.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 9
+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.
 ---
 
 # Spaces
diff --git a/docs-site/docs/guides/tasks.md b/docs-site/docs/guides/tasks.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 2
+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.
 ---
 
 # Tasks
diff --git a/docs-site/docs/intro.md b/docs-site/docs/intro.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 1
+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.
 ---
 
 # Introduction
diff --git a/docs-site/docs/patterns/common-patterns.md b/docs-site/docs/patterns/common-patterns.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 3
+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.
 ---
 
 # Common Patterns
diff --git a/docs-site/docs/patterns/documents.md b/docs-site/docs/patterns/documents.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 4
+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.
 ---
 
 # Working with Documents
diff --git a/docs-site/docs/patterns/environment-setup.md b/docs-site/docs/patterns/environment-setup.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 2
+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.
 ---
 
 # Environment Setup
diff --git a/docs-site/docs/patterns/error-handling.md b/docs-site/docs/patterns/error-handling.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 8
+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.
 ---
 
 # Error Handling
diff --git a/docs-site/docs/patterns/integrations.md b/docs-site/docs/patterns/integrations.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 7
+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.
 ---
 
 # Integration Patterns
diff --git a/docs-site/docs/patterns/introduction.md b/docs-site/docs/patterns/introduction.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 1
+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.
 ---
 
 # Introduction
diff --git a/docs-site/docs/patterns/performance.md b/docs-site/docs/patterns/performance.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 6
+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.
 ---
 
 # Performance Tips
diff --git a/docs-site/docs/patterns/ready-to-run.md b/docs-site/docs/patterns/ready-to-run.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 9
+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.
 ---
 
 # Ready-to-Run Examples
diff --git a/docs-site/docs/patterns/real-world.md b/docs-site/docs/patterns/real-world.md
@@ -1,5 +1,7 @@
 ---
 sidebar_position: 5
+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.
 ---
 
 # Real-World Scenarios
