Документация
DOCS — это библиотека знаний экосистемы Labs — централизованное хранилище всей информации о системе. Каждое руководство, каждая инструкция, каждый справочник находятся здесь.
Что такое DOCS?
DOCS — это библиотека знаний платформы Labs — централизованная система документации, построенная на Nextra, одном из самых современных фреймворков для создания документации, доступных на рынке сегодня.
Это единый источник истины для всей информации о системе. Здесь вы найдёте руководства пользователя, техническую документацию, справочники API и подробные инструкции для каждого приложения экосистемы — от Аутентификации до Профиля пользователя и Профиля организации.
Мощная платформа для знаний
Вся документация поддерживает мультиязычность, поиск и современное форматирование. Ваша информация всегда доступна и легко находится.
Почему Nextra?
Nextra — это современный фреймворк для документации на базе Next.js, который обеспечивает:
| Особенность | Описание |
|---|---|
| Быстрый поиск | Мгновенный поиск по всей документации |
| Мультиязычность | Интерфейс на 4 языках; документация написана на английском, отдельные страницы переведены |
| MDX поддержка | Интерактивные компоненты в документации |
| SEO оптимизация | Автоматическая оптимизация для поисковых систем |
Как мы организуем информацию
Навигация
Интуитивная структура
- Документация организована по приложениям и разделам
- Древовидная навигация для быстрого перемещения
- Хлебные крошки для понимания текущего местоположения
- Автоматическое оглавление на каждой странице
Структура документации зеркально отражает структуру самой системы, что делает поиск информации максимально логичным.
Типы документации
DOCS содержит несколько типов документации для разных целей:
| Тип | Назначение |
|---|---|
| Руководства пользователя | Инструкции для конечных пользователей |
| Техническая документация | Подробная информация для разработчиков |
| Справочники API | Документация по API и интеграциям |
| Руководства администратора | Инструкции по настройке и управлению |
Возможности документации
Интерактивные компоненты
Документация использует современные компоненты для лучшего восприятия информации: блоки с предупреждениями, вкладки, сворачиваемые секции и многое другое.
Примеры кода
Подсветка синтаксиса для более чем 100 языков программирования, копирование кода одним кликом, примеры с объяснениями.
Адаптивный дизайн
Документация отлично выглядит на любых устройствах — от мобильных телефонов до широких мониторов.
Тёмная тема
Переключайтесь между светлой и тёмной темами для комфортного чтения в любое время суток.
Часто задаваемые вопросы
Как найти нужную информацию?
Используйте поиск (Ctrl+K или Cmd+K) для мгновенного поиска по всей документации. Также вы можете использовать древовидную навигацию слева или карточки навигации на главных страницах разделов.
На каких языках доступна документация?
Интерфейс сайта доступен на четырёх языках: английском, русском, тагальском и арабском. Сама документация написана на английском; переводы на русский, тагальский и арабский языки есть для отдельных страниц и могут отставать от английской версии. Если они расходятся, следуйте английскому тексту. Переключатель языков находится в правом верхнем углу. Ваш выбор сохраняется автоматически.
Как предложить улучшение документации?
Если вы заметили ошибку или хотите предложить улучшение, обратитесь в службу поддержки или свяжитесь с командой разработки. Мы ценим обратную связь и постоянно улучшаем документацию.
Документация обновляется автоматически?
Да. Документация обновляется вместе с каждым релизом системы. Все изменения функционала сразу отражаются в соответствующих английских разделах документации; переводы следуют за ними и могут отставать.