Files
crank/docs/README.md
T
bsodfather e93de7015a
CI / Rust Checks (pull_request) Failing after 1s
CI / UI Checks (pull_request) Skipped
CI / Frontend E2E (pull_request) Skipped
CI / Community Image Smoke (pull_request) Skipped
CI / Deploy (pull_request) Skipped
feat(import): complete OpenAPI onboarding and verify delivery
2026-10-09 17:50:38 +03:00

60 lines
3.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Документация Crank
Crank превращает REST API endpoint-ы в MCP-инструменты, которые можно подключать к AI-агентам и MCP-клиентам.
Документация хранится в Markdown-файлах внутри `docs/` и читается прямо из репозитория.
## Начать
- [Введение](./intro.md)
- [Установка](./installation.md)
- [Первый инструмент](./quickstart.md)
- [Подключение MCP-клиента](./mcp-interface.md)
- [Практические API-примеры](./api-examples.md)
## Возможности
- [Веб-интерфейс](./ui.md)
- [REST-инструменты](./protocols/rest.md)
- [Импорт OpenAPI](./openapi-import.md)
- [Секреты и профили авторизации](./secrets-and-auth.md)
- [Журналы и использование](./observability.md)
- [Единая граница REST execution](./execution-boundary.md)
- [Проектирование MCP-инструментов](./tool-design.md)
## Справочник
- [Capability Inventory](./capability-inventory.json) — machine-readable реестр
текущих и целевых flows; canonical path — `docs/capability-inventory.json`.
- [Schema Capability Inventory](./schemas/capability-inventory.schema.json)
- [Capability Baseline](./capability-baseline/manifest.json) — versioned SHA-256
snapshot фактических UI, Admin API и MCP flows, taxonomy, checklist и
sanitized evidence results.
- [Evidence разработки](./development-evidence.md) — clean baseline, проверенная
revision реализации и отдельная запись текущего completion evidence.
- [Completion evidence Epic 1](./epic-1-completion/index.json) — актуальные
development checks после исправлений ретроспективы.
- [Schema Capability Baseline](./schemas/capability-baseline.schema.json) —
fail-closed manifest contract.
- [Настройки окружения](./runtime-config.md)
- [Machine schema runtime-конфигурации](./schemas/runtime-config.schema.json)
- [Миграции PostgreSQL](./migrations.md)
- [Machine sequence миграций](./schemas/migration-sequence.json)
- [Admin API](./admin-api.md)
- [Развертывание](./deployment.md)
- [Production checklist](./production-checklist.md)
- [Troubleshooting](./troubleshooting.md)
- [Архитектура](./architecture.md)
- [Модель данных](./data-model.md)
- [Тестирование](./testing-strategy.md)
- [План приёмочного тестирования всех восьми эпиков](./acceptance-test-plan.md) — сценарии, пороги и шаблоны evidence для отдельной приёмки.
В Inventory только статус `implemented` означает готовность. Статусы `planned`,
`gap` и `blocked` остаются непроходными и не являются заявлением о наличии
функции в текущей Community-версии.
Baseline разделяет implementation status, execution verdict и evidence mode.
Полный pass — только `implemented + automated + pass`; `flaky`, `skipped`,
`not_run` и `manual_only` остаются non-pass. После изменения snapshot должны
обновиться `baseline_version` и manifest checksums.