Перейти к содержимому
supastack
Обзор документации
WebTanStack Start

For AI agents: fetch the complete documentation index at /llms.txt, the full documentation corpus at /llms-full.txt, the agent skill at /skill.md, or this page as Markdown at /ru/docs/tanstack/docs-site.md (or send Accept: text/markdown).

Документация продукта

Выделенное docs-приложение, поставляемое с китом.

Задать вопрос об этом руководстве
Открыть в

Прежде чем начать

Откройте загруженный проект supastack в Visual Studio Code, используя «Файл» → «Открыть папку», затем выберите «Терминал» → «Новый терминал». Корень репозитория — это папка, содержащая package.json, приложения и пакеты. Запустите команду ниже и оставьте терминал открытым. Если команда не распознается, завершите руководство по установке инструмента, прежде чем продолжить.

Сначала прочтите руководство по платформе. Сервер — это процесс приложения, который отвечает на запросы браузера или телефона. Веб читает apps/web-tanstack/.env.local, Expo читает apps/mobile/.env.local, а команды миграции базы данных читают корневой .env. Демонстрация без базы данных / панели мониторинга отделена от реальных учетных записей / аутентификации, для которых необходимо перенести Postgres. Для оформления заказа только на телефоне или компьютере требуется отдельно работающий веб-сервер.

corepack pnpm --filter @supastack/web-tanstack dev

Настройка и конфигурация

apps/docs — это обращённая к покупателю поверхность документации для продукта, который вы строите, отдельная от документации самого кита. Она рендерит собственные гайды вашего продукта с навигацией, якорями страниц и поиском и работает как собственное приложение воркспейса на порту 3001 в разработке.

Держите её контент типизированным и версионируемым в репозитории рядом с функциями, которые он описывает; документ, расходящийся с кодом, хуже отсутствующей страницы.

apps/docs/        Product documentation app
  content/        Guide sources and nav order
  app/            Routes, layout, search

Рабочий процесс внедрения

Моделируйте документацию продукта по структуре кита: стартовый путь, страница на каждую область функций и справочные страницы по конфигурации и API. Переиспользуйте формат гайдов кита, чтобы инструменты (поисковый индекс, копирование как Markdown) продолжали работать.

Привязывайте задачи к страницам: выпуская функцию, обновляйте соответствующий гайд в том же изменении.

Проверка и устранение неполадок

Соберите docs-воркспейс, прокликайте каждую запись навигации, выполните поиск по каждому новому введённому термину и проверьте якорные ссылки после переименований. Считайте сломанные ссылки документации сломанными маршрутами.