Подсистема документации

DWE включает встроенный браузер документации и справочную систему. Доступ ко встроенным докам, проектным докам (когда они есть), рендер markdown с подсветкой синтаксиса и просмотр mermaid-диаграмм прямо на месте.

Страницы

• Интерактивный TUI-браузер — клавиши dwe docs, раскладка, поиск
• Неинтерактивные команды — show, list, search, export, llms-txt, cache clear, а также настройка mermaid и установка mmdc
• Переводы и поведение языка — разрешение локали, раскладка файлов, проверка устаревания по контент-хешу

Быстрый старт

Просмотр доков в интерактивном режиме:

dwe docs

Показ конкретной темы в терминале:

dwe docs show config/services/fields
dwe docs show config/userconfig#переопределения-бинарей

Список всех доступных тем:

dwe docs list

Экспорт всех доков в каталог:

dwe docs export ./my-docs

Проектные доки

DWE автоматически обнаруживает и подключает документацию из каталога ./docs/ вашего проекта.

Когда ./docs/ существует, TUI-браузер показывает вторую верхнеуровневую ветку:

DWE
  concepts/
  config/
  render/
  guides/
  README
Project
  guides/
  examples/

Если ./docs/ отсутствует или пуст, ветка Project опускается.

Структура:

<project>/
  docs/
    guides/
      setup.md
    examples/
      docker.md
    README.md

Горячая перезагрузка: правьте файлы в ./docs/, пока TUI открыт — viewport обновится автоматически (нажмите r для ручного обновления, если автоопределение пропустит правку).

Справочник конфигурации

Переопределение бинарника mmdc

Путь или имя исполняемого файла mermaid-cli. По умолчанию mmdc (ищется в $PATH).

Это переопределяется в файле пользовательской конфигурации (~/.config/dwe/config или .dwe/config в проекте) как плоский ключ binary_mmdc — а не в workspace.yml:

binary_mmdc = /usr/local/bin/mmdc   # абсолютный путь; опустите, чтобы использовать `mmdc` в $PATH (по умолчанию)

См. config/userconfig для полного списка переопределений бинарников.

docs.mermaid

Режим рендера mermaid. Одно из:

• auto — рендер, если mmdc доступен; иначе fallback на сырой блок (по умолчанию)
• mmdc — требовать mmdc; плашка-плейсхолдер, если он не найден
• off — никогда не рендерить; всегда показывать сырые mermaid-блоки

По умолчанию: auto

docs:
  mermaid: auto   # по умолчанию
  mermaid: mmdc   # строгий режим
  mermaid: off    # выключено

docs.cache_size_mb

Максимальный размер кеша mermaid-диаграмм в МБ. По умолчанию 100.

docs:
  cache_size_mb: 50   # 50 МБ кеша
  cache_size_mb: 500  # 500 МБ кеша

Когда кеш превышает лимит, самые старые диаграммы удаляются автоматически (вытеснение по LRU).

Связанные команды

• dwe docs generate — сгенерировать markdown-документацию из пользовательских команд
• dwe validate — проверить документацию на ошибки и осиротевшие записи переводов
• dwe commands list — вывести пользовательские команды с переведёнными описаниями