Skip to content

README e documentação do usuário em PT-BR #33

Closed

Description

@patrickbrandao

Contexto

O README.md ainda é o do Manifest: seções "Cloud version" e "Deploy with one click", badges e assets em .github/assets (api-bot-readme-banner.png, logos, home-gh*.png). Não há documentação do usuário em PT-BR. A instalação via Docker é o único caminho oficial. A atribuição do logo depende de #10, e a seção de privacidade depende de #11 (decidida: ADR 0003) e da implementação dela, #39.

Escopo

  • README.md em PT-BR:
    • o que é o Thinker;
    • origem (snapshot do mnfst/llm-gateway manifest@6.28.6, MIT, crédito à MNFST, Inc.);
    • quick start Docker (install.sh e compose manual);
    • harnesses suportados, links para a documentação e licença;
    • atribuição do logo (texto de Logo: autor, licença e atribuição do ícone Flaticon 5337422 #10).
      Remover as seções Cloud e "Deploy with one click" e os badges da Manifest. Limpar .github/assets.
  • docs/usuario/ com:
    • instalacao-docker.md: requisitos; install.sh; compose manual; variáveis obrigatórias (BETTER_AUTH_SECRET + THINKER_ENCRYPTION_KEY); porta 2099, HOST_BIND_ADDRESS e BETTER_AUTH_URL; proxy reverso com HTTPS; atualização manual de versão (não há aviso de update); backup do volume thinker_pgdata;
    • configuracao.md: referência de variáveis THINKER_* e das demais; gravações (30 dias, S3); e-mail; login social; MCP; cadastro fechado e THINKER_ALLOW_SIGNUP (se aprovada em Fechar o cadastro público depois do primeiro admin #29);
    • primeiros-passos.md: setup do admin, conectar um provedor, criar um agente e a chave thk_, configurar Claude Code, Codex, OpenClaw/Hermes, OpenCode e os SDKs;
    • cli.md: instalação local e comandos da CLI thinker;
    • erros.md: códigos M###, destino dos links de Rebranding do backend: textos, e-mails, MCP e atribuição de provedores #22;
    • privacidade.md: o produto não faz phone-home. Lista exata e completa de todo destino de saída que sobrar no código depois da v0.1, cada um com o gatilho e como desligar. Hoje a lista prevista é:
      • catálogos públicos, a única exceção à regra "sem phone-home" (ADR 0003, implementada em Catálogos públicos: chave THINKER_CATALOG_SYNC e OpenCode Go só com provedor cadastrado #39): openrouter.ai/api/v1/models e models.dev/api.json (boot e uma vez por dia), e raw.githubusercontent.com/anomalyco/opencode/... (só se houver um provedor OpenCode Go cadastrado). Os três são desligados por THINKER_CATALOG_SYNC=false; nesse caso, os custos vêm dos dados embutidos na imagem e muitos modelos ficam sem preço;
      • provedores que o operador configurou: APIs de inferência e de listagem de modelos (incluindo Ollama Cloud em ollama.com e o OLLAMA_HOST local), e as URLs de provedores customizados, inclusive na LAN;
      • fluxos OAuth e de assinatura dos provedores que o operador conecta (ex.: auth.openai.com, claude.ai/console.anthropic.com, accounts.google.com/oauth2.googleapis.com/cloudcode-pa.googleapis.com, api.github.com/copilot_internal, auth.x.ai, AWS SSO); a lista sai de routing/oauth e routing/proxy/provider-endpoints.ts no momento da escrita;
      • e-mail, se EMAIL_PROVIDER estiver definido (Resend, SendGrid, Mailgun);
      • login social, se configurado (Google, GitHub, Discord);
      • armazenamento S3 das gravações, se configurado (THINKER_RECORDING_S3_ENDPOINT);
      • CIMD do MCP: o documento de metadados na URL client_id HTTPS informada por um cliente MCP durante o OAuth; só endereços públicos, salvo THINKER_CIMD_ALLOW_PRIVATE=true (Modo único self-hosted: remover MANIFEST_MODE #18).
        Dizer explicitamente que modelparams.dev (removido em Remover phone-home do backend e da CLI #17), telemetria, update-check e Sentry não existem, e que o dashboard não faz requisições a terceiros (os links externos só abrem por clique). O docs-ptbr confere a lista com o backend-dev contra o código (grep por fetch( e URLs fixas em packages/backend/src) antes do merge;
    • deploy-comunidade.md: templates não testados.
  • docs/providers/subscription-based-providers.md → traduzir para PT-BR no mesmo caminho (docs/providers/, para onde ProviderSubscriptionTab.tsx aponta desde Rebranding do dashboard #25), com o nome provedores-por-assinatura.md (o link de Rebranding do dashboard #25 aponta para a pasta). É documentação do usuário (como reaproveitar planos pagos), então não pode ficar em inglês.
  • docker/DOCKER_README.md: descrição curta em PT-BR para o Docker Hub.

Fora de escopo

Critérios de aceite

  • Seguindo só instalacao-docker.md numa máquina limpa, o qa-docker (ou o usuário) sobe a instância e chega ao primeiro chat via mock.
  • Todos os links internos resolvem.
  • A lista de privacidade.md foi conferida contra o código pelo backend-dev (registro no PR); Baseline do qa-docker: smoke e e2e da imagem v0.1 #34 confirma na rede que nenhum destino fora dela é contatado.
  • node scripts/check-legacy-names.js --strict não acusa nada nos arquivos tocados por esta issue.

Dependências

Agente responsável

docs-ptbr

Activity

  1. added this to the v0.1 milestone on Oct 10, 2026
  2. patrickbrandao commented on Oct 11, 2026

    @patrickbrandao
    OwnerAuthor
  3. patrickbrandao commented on Oct 11, 2026

    @patrickbrandao
    OwnerAuthor

    Da QA do PR #71, para a documentação de instalação e operação: a verificação de token do MCP busca o JWKS em BETTER_AUTH_URL. Se essa URL não for acessível de dentro do container (porta do host diferente da interna sem PORT correspondente, ou URL pública que o container não alcança), as chamadas MCP respondem 401 no token payload. Documentar: BETTER_AUTH_URL precisa ser alcançável de dentro do container; atrás de proxy reverso, garantir a resolução do nome ou o hairpin NAT.

  4. patrickbrandao commented on Oct 11, 2026

    @patrickbrandao
    OwnerAuthor

    Restos do #60 (#15) para o README e a documentação: o badge de estrelas do GitHub em README.md:24 e docker/DOCKER_README.md:11, a linha "Gemini Free" em README.md:100 e em dashboard-redesign-brief.md:189.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:docsDocumentação em PT-BR e notas de release

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions