Documentação do produto

Antes de começar

Abra seu projeto supastack baixado em Visual Studio Code usando Arquivo → Abrir pasta e escolha Terminal → Novo Terminal. A raiz do repositório é a pasta que contém package.json, apps e pacotes. Execute o comando abaixo e deixe seu terminal aberto. Se um comando não for reconhecido, conclua o guia de instalação da ferramenta antes de continuar.

Leia o tutorial da plataforma primeiro. Um servidor é o processo do aplicativo que responde às solicitações do navegador ou do telefone. A Web lê apps/web-tanstack/.env.local, Expo lê apps/mobile/.env.local e os comandos de migração de banco de dados leem root .env. A demonstração sem banco de dados/painel é separada das contas reais/auth, que precisam migrar para Postgres. Uma finalização de compra somente por telefone ou desktop precisa de um back-end da Web executado separadamente.

• Instale as ferramentas e obtenha o código
• Aprenda comandos, arquivos e configuração
• Conclua o tutorial inicial da Web

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

Instalação e configuração

O apps/docs é a superfície de documentação virada para o comprador do produto que constróis — separada desta documentação do kit. Renderiza os guias do teu próprio produto com navegação, âncoras por página e pesquisa, e corre como a sua própria app do workspace na porta 3001 em desenvolvimento.

Mantém o seu conteúdo tipado e versionado no repositório junto das funcionalidades que descreve; uma doc que diverge do código é pior do que uma página em falta.

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

Fluxo de implementação

Modela as docs do teu produto sobre a estrutura do kit: um percurso de início, uma página por área funcional e páginas de referência para configuração e APIs. Reutiliza o formato de guia do kit para que as ferramentas (índice de pesquisa, copiar como Markdown) continuem a funcionar.

Liga tarefas a páginas: quando lanças uma funcionalidade, atualiza o guia correspondente na mesma alteração.

Verificação e resolução de problemas

Compila o workspace docs, clica em cada entrada de navegação, executa uma pesquisa por cada termo novo que introduzires e verifica os links de âncora após renomeações. Trata links de documentação partidos como rotas partidas.