Об этой документационной инфраструктуре

Документация SRDD использует файлы Markdown, хранящиеся в каталоге `documentation` репозитория GitHub. Каждый файл Markdown содержит YAML-заголовок для метаданных и использует стандартный Markdown с поддержкой GitHub для контента. Перекрестные ссылки между документами используют синтаксис заполнителей для облегчения платформенно-независимых ссылок. Конвейер GitHub Actions автоматически обрабатывает сборку и публикацию документации. Конвейер сначала преобразует заполнители для развертывания GitHub Pages с использованием Jekyll. Затем он синхронизирует контент с Dev.to посредством двухпроходного процесса. Первый проход создает или обновляет статьи Dev.to, захватывая сгенерированные URL-адреса. Второй проход разрешает внутренние ссылки на Dev.to, используя сгенерированную карту URL-адресов. Канонические URL-адреса в статьях Dev.to указывают на версию GitHub Pages, обеспечивая преимущества SEO и единый источник истины. Добавление новой документации включает в себя создание файла Markdown и ссылку на него с использованием синтаксиса заполнителей. Конвейер требует ключ API Dev.to и URL-адрес GitHub Pages в качестве переменных среды. Этот подход обеспечивает функциональность "написал один раз, опубликовал везде" для документации SRDD. Этот процесс гарантирует, что контент будет последовательно доступен на нескольких платформах.