Проекты и репозитории

Зачем это нужно

Проект — это ваш основной контейнер. Внутри него живут страницы
документации, команда с правами, история изменений и (опционально)
связь с репозиториями кода.

Обычно один проект соответствует одной из трёх сущностей:

• Один микросервис / библиотека — документация API, внутренней
  логики, README для разработчиков.

• Один продукт / фича — смешанная документация для продакт-,
  дизайн- и инженерной команд.

• Одна команда или отдел — внутренняя база знаний, процессы,
  онбординг, ретро.

Репозиторий — это связь с GitHub-репой. Один проект может
ссылаться на несколько репозиториев одновременно (монорепы, тесно
связанные сервисы), и наоборот — одна репа может фигурировать в
нескольких проектах (например, утилитарная библиотека используется
тремя командами).

Как создать проект

1. Откройте экран /projects — там же, где видите карточки всех ваших
   проектов.

2. Нажмите Create New Project.

3. Выберите тип в модалке:

   • Blank project — пустой проект с одной пустой страницей.
     Лучше всего для документации, которая пишется с нуля.

   • From GitHub — вы выбираете репозиторий из списка установленных
     (см. раздел «Интеграции»). Nextdocs склонирует его,
     автоматически сгенерирует первую версию документации по коду и
     положит её в дерево страниц. Подходит, когда хочется получить
     «стартовую» базу знаний по существующему коду без ручного ввода.

   • From ZIP archive — загружаете .zip с исходниками. Тот же
     сценарий что GitHub, но без интеграции.

   • From Confluence export — импорт документации из Confluence в
     виде .zip-архива, экспортированного в HTML.

4. Для всех вариантов задайте название, описание и
   видимость: private (только приглашённые) или public
   (доступно по ссылке без авторизации).

После создания вы окажетесь на странице проекта — слева дерево
страниц, в центре редактор, справа — вкладки с комментариями,
оглавлением и историей.

Управление проектом

В меню проекта (иконка-шестерёнка на карточке или в хедере страницы):

• Rename — изменить название. Все ссылки на проект автоматически
  подхватят новое имя.

• Visibility — переключить публичность. Перевод в public делает
  страницы индексируемыми для поисковиков (Google и т.д.) и
  доступными без логина.

• Delete — удалить проект. Это необратимо: удалятся все
  страницы, комментарии, история. Приватные репозитории,
  подключённые к проекту, остаются — удаляется только связь.

Страницы внутри проекта

Дерево страниц — это иерархия, как папки с файлами. Любую страницу
можно:

• создать кнопкой «+» в дереве — страница появится в корне или
  как дочерняя (выберите курсором место);

• переименовать двойным кликом по имени — изменение синхронно
  увидят все открывшие проект в ту же секунду;

• перетащить мышью в другое место дерева — это работает как
  обычный drag&drop и тоже синхронно;

• удалить через контекстное меню (правая кнопка) — восстановить
  удалённую страницу можно из истории проекта.

У каждой страницы есть адрес вида /projects/{id}/{pageId}, которым
удобно делиться в Slack/почте — получатель попадёт прямо на нужную
страницу (при условии что у него есть доступ).

Подключение репозиториев

Отдельный экран /repositories показывает список всех репозиториев,
к которым у вас есть доступ.

• Add from GitHub — клонирует новый репозиторий (нужна
  установка GitHub App, см. «Интеграции»).

• Attach to project — связывает уже загруженный репозиторий с
  существующим проектом. На странице проекта появится кнопка
  «Generate from repo», которая запустит AI-генерацию документации по
  исходникам.

• Detach — убирает связь. Сам репозиторий в Nextdocs остаётся,
  проект — тоже; просто исчезает возможность генерации.

• Share — дать коллегам доступ к репозиторию (чтобы они тоже могли
  привязывать его к своим проектам).

Типовые сценарии

Новая команда пришла, нужен wiki с нуля. Blank project → создаёте
страницы вручную → в дереве структурируете по отделам / темам.

Есть код, нужна документация API. From GitHub → выбираете репу →
Nextdocs генерирует первую версию → редактируете ключевые места →
подключаете AI-чат для поиска по коду.

Есть Confluence-база, переезжаете. Экспортируете пространство
Confluence в HTML-архив → From Confluence export → получаете зеркало
старой структуры в Nextdocs.

Микросервисный проект, 5 реп на один продукт. Создаёте один
проект → на экране Repositories добавляете все 5 реп → на странице
проекта привязываете каждую → AI-чат умеет искать одновременно по
всем привязанным репам.

Ограничения

• Максимум 1 МБ на одну страницу (Yjs-документ). Если вы собираетесь
  хранить книгу — разбейте на главы-страницы.

• Bulk-операции (массовое удаление, перемещение нескольких страниц
  сразу) пока не поддерживаются — только по одной.

• Проекты из public-видимости не резервируются отдельно от проекта
  — снимок делается автоматически, но если проект удалён, публичная
  версия тоже пропадает.