mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-05-06 02:07:00 +00:00
docs(i18n): apply deep machine translation to 33 languages
This commit is contained in:
parent
5085dcf96f
commit
fa886231d3
466 changed files with 92226 additions and 147160 deletions
|
|
@ -4,34 +4,26 @@
|
|||
|
||||
---
|
||||
|
||||
Use this checklist before tagging or publishing a new OmniRoute release.
|
||||
Используйте этот контрольный список, прежде чем отмечать тегами или публиковать новую версию OmniRoute.## Version and Changelog
|
||||
|
||||
## Version and Changelog
|
||||
1. Добавьте версию package.json (x.y.z) в ветку выпуска.
|
||||
2. Переместите примечания к выпуску из `## [Unreleased]` в `CHANGELOG.md` в устаревший раздел:
|
||||
- `## [x.y.z] — ГГГГ-ММ-ДД`
|
||||
3. Оставьте `## [Unreleased]` в качестве первого раздела журнала изменений для предстоящей работы.
|
||||
4. Убедитесь, что последний раздел semver в CHANGELOG.md равен версии package.json.## API Docs
|
||||
|
||||
1. Bump `package.json` version (`x.y.z`) in the release branch.
|
||||
2. Move release notes from `## [Unreleased]` in `CHANGELOG.md` to a dated section:
|
||||
- `## [x.y.z] — YYYY-MM-DD`
|
||||
3. Keep `## [Unreleased]` as the first changelog section for upcoming work.
|
||||
4. Ensure the latest semver section in `CHANGELOG.md` equals `package.json` version.
|
||||
5. Обновите `docs/openapi.yaml`:
|
||||
- `info.version` должна совпадать с версией `package.json`.
|
||||
6. Проверьте примеры конечных точек, если контракты API изменились.## Runtime Docs
|
||||
|
||||
## API Docs
|
||||
7. Просмотрите `docs/ARCHITECTURE.md` на наличие отклонений в хранилище/время выполнения.
|
||||
8. Просмотрите `docs/TROUBLESHOOTING.md` на наличие переменных окружения и отклонений в работе.
|
||||
9. Обновите локализованные документы, если исходные документы значительно изменились.## Automated Check
|
||||
|
||||
1. Update `docs/openapi.yaml`:
|
||||
- `info.version` must equal `package.json` version.
|
||||
2. Validate endpoint examples if API contracts changed.
|
||||
|
||||
## Runtime Docs
|
||||
|
||||
1. Review `docs/ARCHITECTURE.md` for storage/runtime drift.
|
||||
2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift.
|
||||
3. Update localized docs if source docs changed significantly.
|
||||
|
||||
## Automated Check
|
||||
|
||||
Run the sync guard locally before opening PR:
|
||||
|
||||
```bash
|
||||
Прежде чем открывать PR, запустите защиту синхронизации локально:```bash
|
||||
npm run check:docs-sync
|
||||
|
||||
```
|
||||
|
||||
CI also runs this check in `.github/workflows/ci.yml` (lint job).
|
||||
CI также запускает эту проверку в `.github/workflows/ci.yml` (задание lint).
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue