docs: make documentation checks self-contained
Docs security / security (pull_request) Successful in 6s
Docs verify / verify (pull_request) Successful in 11s
Conventional commits / commits (pull_request) Successful in 16s
Docs security / security (push) Successful in 9s
Docs verify / verify (push) Successful in 10s
Docs security / security (pull_request) Successful in 6s
Docs verify / verify (pull_request) Successful in 11s
Conventional commits / commits (pull_request) Successful in 16s
Docs security / security (push) Successful in 9s
Docs verify / verify (push) Successful in 10s
This commit was merged in pull request #14.
This commit is contained in:
+13
-15
@@ -8,13 +8,13 @@ Docs даёт самостоятельное понимание продукта
|
||||
|
||||
| Вид знания | Где поддерживается |
|
||||
| --- | --- |
|
||||
| Согласованное проверяемое поведение: требования и сценарии | [Основные спецификации](../specs/AI_INDEX.md) в `specs/openspec/specs/` |
|
||||
| Согласованное проверяемое поведение: требования и сценарии | [Основные спецификации](https://git.personal.ksv741.ru/WealthLedger/specs/src/commit/9e227a563dda67620f0ad78228aa8a4c18bf35a0/AI_INDEX.md) в `specs/openspec/specs/` |
|
||||
| Предложения изменений, их проектирование и задачи | OpenSpec changes в существующем Store `wealth-ledger-specs`, `specs/openspec/changes/` |
|
||||
| Понимание системы, областей и взаимодействий | Тематические страницы docs |
|
||||
| Принятые решения и подтверждённые причины | Единственный журнал [docs/adr](adr/README.md) |
|
||||
| Конкретная реализация и технические контракты | Код, тесты, схемы, конфигурация; публичный OpenAPI формирует backend |
|
||||
| Размещение кода, conventions, команды разработки и проверки | Локальные инструкции frontend/backend |
|
||||
| Выбор репозитория и типа знания | Корневой [AGENTS](../AGENTS.md) |
|
||||
| Работа над docs | Локальные [AGENTS](AGENTS.md) и этот документ |
|
||||
|
||||
История аудитов и проверок остаётся в Git, Issues и PR. `CHANGELOG.md`
|
||||
генерируется release-it из commits; вручную дублировать его на тематических страницах не нужно.
|
||||
@@ -86,9 +86,11 @@ Docs объясняет смысл контракта, не вводя неза
|
||||
Нужные точные значения сопровождай определяющим источником, чтобы не создать
|
||||
конкурирующую норму. Паспорта страниц, Evidence-секции и номера строк не требуются.
|
||||
|
||||
Внутри docs используем относительные Markdown-ссылки. Между репозиториями —
|
||||
относительный путь через соседний корень, например `../specs/AI_INDEX.md` из README.
|
||||
Проверяй регистр, файл и якорь в фактическом workspace. Перенос требует исправить
|
||||
Внутри docs используем относительные Markdown-ссылки. Внешние репозитории —
|
||||
необязательные справочные веб-ссылки на опубликованный источник. Основной текст
|
||||
и инструкции должны быть понятны без открытия этих ссылок. Проверяй локальные
|
||||
файлы/якоря; для удалённых источников не обещай проверку их доступности CI.
|
||||
Перенос требует исправить
|
||||
входящие ссылки активных Markdown-документов; исторические архивы и dated audits
|
||||
сохраняют адреса своего времени. Короткий указатель оставляем только при реальной
|
||||
необходимости совместимости, без второй копии содержания.
|
||||
@@ -153,8 +155,7 @@ npm run verify
|
||||
Существующий gate запускает Markdown lint с проверкой относительных ссылок
|
||||
и якорей, затем `git diff --check`. Он охватывает новые Markdown-файлы;
|
||||
обычный diff их не показывает, поэтому отдельно просмотри untracked-содержание.
|
||||
При изменениях соседних репозиториев выполни там `git diff --check` и проверь
|
||||
затронутые ссылки. Markdown-only правки не требуют тестов всего приложения.
|
||||
Markdown-only правки не требуют тестов приложения или соседнего checkout.
|
||||
|
||||
Правило relative-links не проверяет внешние URL и HTML-ссылки. Mermaid-рендер
|
||||
в gate не входит; используй доступный локальный рендерер без отправки материалов
|
||||
@@ -169,13 +170,10 @@ npm run verify
|
||||
### CI и обновления зависимостей
|
||||
|
||||
`.gitea/workflows/verify.yml` запускает этот gate на push и PR с Node
|
||||
из `.nvmrc` и установкой через `npm ci`. Checkout docs размещается внутри
|
||||
workspace из `WealthLedger/main`, рядом с frontend, backend и specs. Соседние
|
||||
репозитории для разработки берутся из `develop`; для `main`, PR в `main`
|
||||
и `release/*` — из полных SHA в `.ci/refs.json`. SHA всех пяти участников
|
||||
сохраняются в логе.
|
||||
Ошибка checkout, Markdown или относительной ссылки завершает job с FAIL.
|
||||
Это проверка ссылок на выбранные revisions, без Mermaid-render и semantic review.
|
||||
из `.nvmrc` и установкой через `npm ci`. Скачивается только docs;
|
||||
его SHA сохраняется в логе. Ошибка checkout, Markdown или внутренней ссылки
|
||||
завершает job с FAIL. Внешние веб-ссылки — справочные; CI не проверяет их
|
||||
доступность, Mermaid-render или semantic correctness.
|
||||
|
||||
`security.yml` при push, PR и ежедневно проверяет всю Git-историю через
|
||||
Gitleaks 8.30.1 с redacted-выводом и все npm dependencies через
|
||||
@@ -187,4 +185,4 @@ Renovate объединяет minor/patch updates; major требует согл
|
||||
Dependency Dashboard, automerge не включён. Required checks включаются
|
||||
отдельно в Gitea; workflow сам по себе не запрещает merge.
|
||||
|
||||
Версии и ветки: [процесс релиза](../README.md#релизы-и-ветки).
|
||||
Версии и ветки: [процесс релиза](README.md#релизы).
|
||||
|
||||
Reference in New Issue
Block a user