О документации CyberGo
Сайт документации
Сайт документации CyberGo — единый центр технической документации организации CyberGoDev, предоставляющий подробную документацию на пяти языках — китайском, английском, корейском, японском и русском — для всех библиотек Go с открытым исходным кодом.
Этот сайт помогает разработчикам быстро приступить к работе и глубоко понять функциональность, API и лучшие практики каждой библиотеки для эффективного и безопасного использования в продакшене.
Охват документации
| Проект | Описание | GitHub |
|---|---|---|
| JSON | Высокопроизводительная потокобезопасная библиотека обработки JSON | cybergodev/json |
| JWT | Библиотека JWT продакшен-уровня всего с 3 функциями | cybergodev/jwt |
| HTTPC | Современный высокопроизводительный HTTP-клиент с поддержкой TLS 1.2+ и защитой от SSRF | cybergodev/httpc |
| HTML | Инструмент извлечения HTML-контента продакшен-уровня с интеллектуальным распознаванием статей | cybergodev/html |
| DD | Высокопроизводительная библиотека логирования — более 3 млн операций/сек | cybergodev/dd |
| ENV | Готовая к продакшену библиотека управления переменными окружения без зависимостей | cybergodev/env |
Как внести вклад
Мы приветствуем любой вклад в улучшение качества документации:
Редактирование документации
На каждой странице документации в правом верхнем углу есть кнопка «Редактировать эту страницу на GitHub». Нажмите для прямого редактирования и отправки Pull Request.
Сообщение о проблемах
Если вы обнаружили ошибки или пробелы в документации, сообщите об этом:
- Сообщить о проблеме в документации — отправить сообщение об ошибке или предложение по улучшению
- GitHub Discussions — задавать вопросы, обсуждать и делиться опытом
Процесс участия
- Сделайте Fork репозитория docs-site
- Создайте новую ветку для изменений
- Отправьте Pull Request с описанием изменений
- Дождитесь рецензирования и слияния
Технологический стек
Сайт создан с использованием следующих технологий:
| Технология | Назначение |
|---|---|
| VitePress | Генератор статических сайтов |
| Vue 3 | Фреймворк фронтенд-компонентов |
| TypeScript | Конфигурация и скрипты |
| GitHub Pages | Хостинг и автоматическое развёртывание |
Контакты
- GitHub Organization: cybergodev
- Репозиторий документации: cybergodev/docs-site
- Трекер проблем: GitHub Issues