Как обновлять руководство
Сайт GitHub Pages
Порядок подключения собственного поддомена и проверки старых ссылок — адрес сайта и перенос. Смену адреса публикуйте согласованно с DNS и проверкой HTTPS.
Сайт читает те же Markdown-файлы. После слияния в main GitHub Pages автоматически пересобирает публикацию из корня репозитория.
Конфигурация — _config.yml, тема Just the Docs закреплена на версии v0.12.0.
Встроенный jekyll-relative-links преобразует локальные ссылки .md в адреса страниц сайта; вручную заменять их на .html в исходниках не нужно.
YAML в начале страниц задаёт название, раздел и порядок меню. При добавлении модуля обновите modules/index.md и README.
После изменения проверьте сборку Pages, опубликованную страницу, меню на телефоне и внутренние ссылки.
Поиск использует штатный индекс темы и _includes/lunr/custom-index.js: английская обработка, отбрасывающая кириллицу, отключена. Проверяйте запросы на русском и английском, например «субагенты» и «PowerShell». Поиск поддерживает совпадения и префиксы; морфологический разбор русского языка не заявлен.
Где менять учебный материал
Счётчик Яндекс Метрики задаётся в _config.yml через yandex_metrika_id. Общий head_custom.html подключает переданный владельцем JavaScript, а footer содержит noscript-изображение в теле страницы. Чтобы отключить счётчик, удалите значение параметра; не добавляйте второй экземпляр кода в отдельные страницы. Проверяйте фактическую загрузку тега и приём данных в кабинете Метрики отдельно.
modules/00.md–modules/13.md: основные модули.READING.md: самостоятельные русские разборы для чтения без практики.docs/: начало работы, практикум, PowerShell, шаблоны, источники и проверки.updates/: свежие возможности и сценарии; указывайте клиент, версию, дату сверки и ограничения.README.md: оглавление и маршруты. Поддерживайте его ссылки при перемещениях.
Пишите по-русски. Код и названия настроек сохраняйте в исходном написании. При добавлении упражнения оставляйте альтернативу для читателя без терминала и модели.
Проверка продуктового изменения
- Откройте текущую официальную страницу OpenAI, а не только поисковый сниппет.
- Проверьте интерфейс применения: CLI, IDE, desktop, Windows, WSL или cloud.
- Запишите дату, ссылку и ограничение версии/аккаунта, если оно есть.
- Обновите затронутые примеры, теоретический разбор и строку в
docs/SOURCES.md. - Если поведение проверено запуском, укажите версию, команду, среду и результат в
docs/VERIFICATION.md. Если нет — напишите «проверено по документации; не запускалось».
sources-manifest.json — исторический реестр сверки от 24 октября 2026 года.
Не заменяйте его SHA-256 случайными значениями. Добавляйте запись нового снимка
только после фактической загрузки. Полные тела сторонних страниц не храните здесь.
Для раздела новых возможностей первичный пост Tibo служит поводом для проверки, а не заменой официальной инструкции. Если пост недоступен, не выдавайте его пересказ за прочитанный источник. Отделяйте анонс, подтверждённый релиз, доступность аккаунту и собственный успешный запуск. Не называйте рабочий сценарий личным опытом без фактического выполнения.
Windows-примеры
По умолчанию поддерживайте PowerShell 5.1 и 7. Отдельно помечайте примеры только для WSL.
Учитывайте пути с пробелами и кириллицей, кодировку UTF-8, -LiteralPath,
остановку после неуспешного перехода в папку и коды завершения внешних программ.
Синтаксический разбор не приравнивайте к успешному интеграционному запуску.
Не меняйте глобальные настройки и не публикуйте секреты ради проверки примера.
Проверка документации
- Все локальные ссылки ведут к существующим файлам; якоря сохраняются.
- В модулях работают переходы назад, в оглавление и дальше.
- Кодовые блоки закрыты, таблицы читаются на GitHub.
- Новый продуктовый факт имеет официальный источник и дату сверки.
- Утверждения о запуске подтверждены, ограничения сохранены.
- Содержательная правка проходит независимую вычитку.
Предложение правки
Перед отправкой текста прочитайте условия использования. Для своих новых текстовых дополнений явно укажите согласие на CC BY 4.0 либо предложите отдельное согласование прав. Не меняйте лицензию чужих материалов и сохраняйте уведомления MIT; права на присылаемый материал должны позволять его публикацию.
В блоке практического использования группируйте находки по тройке «задача → результат → проверка». Повторная статья или другой skill для того же результата обычно дополняет существующий разбор. Отмечайте, что является функцией Codex, а что — возможностью стороннего инструмента. Не переносите в публичные страницы личные заметки и служебные ссылки из радара.
Создайте ветку от актуальной основной ветки. В Pull Request укажите проблему,
изменённые модули, официальный источник, дату сверки, выполненные проверки и непроверенное.
Не коммитьте напрямую в основную ветку. Добавьте запись в CHANGELOG.md.
Для будущих изменений используйте новый раздел с датой, не переписывайте историю первой редакции.
Вопрос или сообщение об устаревшей команде можно оформить в Issues: укажите модуль, пример, версию Codex, Windows/WSL, точный симптом и ссылку на источник. Не прикладывайте токены, пользовательские документы или полный журнал с личными данными.