Files

T

Zimin A.N. 6c8cc21204 docs(api): mark 4/5 pending endpoints shipped, workflow API deferred

Status table в pending-endpoints.md обновлён: endpoints #1, #2, #4, #5
landed в MR !95-!98 в session 2026-05-11. Workflow API (#3) deferred —
требует отдельной design discussion + sprint (state machine + RBAC pool
model parallel to record-level DraftController architecture).

2026-05-11 23:15:41 +03:00

integration

docs(api): mark 4/5 pending endpoints shipped, workflow API deferred

2026-05-11 23:15:41 +03:00

.gitignore

docs: Diplodoc setup + полное руководство интеграции по API

2026-05-07 23:19:02 +03:00

.yfm

docs: split integrator guide (Diplodoc) vs internal docs + add build-docs CI

2026-05-07 23:27:03 +03:00

Dockerfile

fix(ci): pnpm via npm install (skip corepack) — Dockerfile + build-docs job

2026-05-08 00:35:41 +03:00

index.md

feat(docs): вернуть YFM tabs syntax + bundle runtime assets

2026-05-08 09:09:51 +03:00

nginx.conf

fix(docs/nginx): убрать try_files в unhashed fallback — alias bug

2026-05-08 09:22:15 +03:00

package.json

feat(docs): вернуть YFM tabs syntax + bundle runtime assets

2026-05-08 09:09:51 +03:00

pnpm-lock.yaml

feat(docs): вернуть YFM tabs syntax + bundle runtime assets

2026-05-08 09:09:51 +03:00

README.md

docs: split integrator guide (Diplodoc) vs internal docs + add build-docs CI

2026-05-07 23:27:03 +03:00

toc.yaml

docs(api): pending-endpoints brief for backend team

2026-05-11 22:47:24 +03:00

README.md

Ordinis Integrator Guide (Diplodoc / YFM)

Consumer-facing документация Ordinis НСИ ЦУОД. Build через Diplodoc (open-source documentation platform от Yandex), source — YFM (Yandex Flavored Markdown).

Scope: только то, что нужно интеграторам (Альтум team, BI, third-party consumers). Operator runbooks, архитектурные deep-dives и project state — во внутренней документации в ../docs-internal/, не в Diplodoc build.

Структура

docs/
├── package.json           # @diplodoc/cli + build scripts
├── .yfm                   # Diplodoc config
├── toc.yaml               # Содержание / sidebar
├── index.md               # Главная (integrator-focused tabs)
└── integration/
    ├── api/               # 11 глав про API integration
    │   ├── index.md
    │   ├── auth.md
    │   ├── read-endpoints.md
    │   ├── events.md
    │   ├── webhooks.md
    │   ├── bitemporal.md
    │   ├── x-references.md
    │   ├── caching.md
    │   ├── errors.md
    │   ├── best-practices.md
    │   └── bundle-cuod.md
    └── altum-imaging-order.md

Внутренние материалы (НЕ в Diplodoc build):

docs-internal/
├── ops/      # Operator runbook (on-call)
├── status/   # Project state snapshots
└── tech/     # Legacy technical pages

Сборка

Требуется Node 18+.

cd docs
pnpm install
pnpm build           # → ./_dist (HTML)
pnpm serve           # → http://localhost:8088
pnpm dev             # build + serve одной командой

Build output (_dist/) — статический HTML, deployable в:

GitLab Pages
S3 / object storage
nginx/ingress на k8s cluster

Editorial guidelines

Этот set документации — public contract для интеграторов:

Не leak'аем internal architecture — никаких internal alert names, service paths, internal infrastructure URLs.
API contract стабилен — изменения требуют semver bump + announcement.
Consumer-side examples для каждой концепции (Python, Node, либо Spring).
Версионирование через bundle / API major.

Для operator-side / dev-side материалов — docs-internal/ либо design docs в ~/.gstack/projects/claude/.

YFM extensions используются

{% list tabs %} — табы для switching между audiences
{% note info|warning|tip %} — выделенные блоки
mermaid code blocks — диаграммы (graph LR, gantt)
toc.yaml cross-links — sidebar navigation

Roadmap

Базовая структура integration guide (11 страниц)
CI job build-docs в .gitlab-ci.yml
GitLab Pages / k8s ingress deployment
Search plugin
EN translation (через langs: в .yfm)
Includes для shared snippets (auth examples, error tables)
Versioning — separate doc trees per API major version