Skip to content

docs: PT-BR user docs, developer guide and 0.1.0 upgrade notes - #166

Merged
patrickbrandao merged 2 commits into
mainfrom
docs/ptbr-docs
Oct 14, 2026
Merged

patrickbrandao merged 2 commits into
mainfrom
docs/ptbr-docs

Conversation

@patrickbrandao

Copy link
Copy Markdown
Owner

Closes #33
Closes #32
Closes #152
Part of #158

What changed

  • README e documentação do usuário em PT-BR #33: README in PT-BR (logo credit, MIT attribution to mnfst/llm-gateway, no Cloud/one-click sections, old .github/assets removed). New docs/usuario/: instalacao-docker, configuracao (every env var checked against the code), primeiros-passos, conectar-harnesses (Claude Code, Codex, OpenCode, OpenClaw/Hermes, SDKs; snippets taken from packages/shared/src/setup-snippets.ts), provedores-e-roteamento (default tier needed for auto, complexity routing, fallback), cli, solucao-de-problemas (M-codes, links to docs/erros.md), privacidade (ADR 0003 list plus CIMD), deploy-comunidade (marked untested). docker/DOCKER_README.md is now a short PT-BR page.
  • Guia do desenvolvedor do Thinker #32: docs/dev/guia.md (architecture, commands, test:e2e:docker, migrations, auth, routing, recordings, CI, releases, merge policy, agents) and docs/dev/terminologia.md (translated glossary, Autofix removed). docs/dev/manifest-guide.md and manifest-agents.md are now short pointers because CLAUDE.md and backend-dev.md still link to them. AGENTS.md updated. docs/glossary.md removed.
  • docs: 0.1.0 upgrade notes for retention, encryption key and closed signup #152: docs/releases/0.1.0.md gains the upgrade section (30-day retention, mandatory encryption key and the PREVIOUS recipe, closed signup, setup token multi-replica limitation, compose PREVIOUS/ALLOW_SIGNUP). install.sh comment fixed, .env.example retention default corrected (30, not 365), crypto.util.ts doc comment updated and the missing-key boot error now points at the recipe (spec added).
  • test: proxy e2e for provider_url_blocked and small follow-ups from #153/#155/#156 #158 (nit from fix(providers): warn on unrecognized THINKER_CATALOG_SYNC and align MCP routing status #153): CIMD fetch mentioned in the "No telemetry" section of DOCKER_README.md and in .env.example.

Not in this PR

CLAUDE.md is untouched (governance). CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md, dashboard-redesign-brief.md, docs/db-footprint-evaluation.md (+ script), docs/model-parameters-schema.md move, the translation of docs/providers/subscription-based-providers.md, and the legacy-name allowlist entry are left for a follow-up.

Tests

  • npx jest src/common/utils/crypto.util.spec.ts in packages/backend: 51 passed
  • eslint and prettier on the two touched TS files: clean; tsc -p tsconfig.test.json --noEmit (backend): clean
  • vitest run tests/brand-assets.test.ts (frontend): 24 passed
  • node scripts/check-changesets.js: OK
  • Relative links and anchors in every touched markdown file checked with a script: no broken links

qa-docker is not needed (docs plus one error-message string).

🤖 Generated with Claude Code

patrickbrandao and others added 2 commits October 14, 2026 12:00
Rewrite the README in Portuguese and add docs/usuario/ (installation,
configuration, first steps, harnesses, providers and routing, CLI,
troubleshooting, privacy, community deploy templates). Replace the
inherited developer guide with docs/dev/guia.md and merge the glossary
into docs/dev/terminologia.md without the Autofix material. Finish the
0.1.0 notes (retention, encryption key rotation, closed signup, setup
token limitation). Shorten DOCKER_README into PT-BR, mention the CIMD
fetch in the no-telemetry sections, fix the stale install.sh comment and
the retention default in .env.example, and point the missing-key boot
error at the upgrade recipe.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Fix the CONTRIBUTING release flow, drop the upstream-only brief and
DB footprint study (with its script), move the model parameters schema
under docs/dev and translate the subscription providers page to PT-BR.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@patrickbrandao

Copy link
Copy Markdown
Owner Author

Review of PR #166 (docs: PT-BR user docs, developer guide, 0.1.0 upgrade notes)

Blockers: none.

What I checked at the reviewed SHA

  • Privacy page (README e documentação do usuário em PT-BR #33): I grepped every fixed URL in packages/backend/src. The only HTTP clients are fetch, ssrf-safe-fetch.ts and cimd-client-metadata-fetch.ts. The only fixed destinations that are not providers are openrouter.ai, models.dev/api.json (database/models-dev-sync.service.ts:155) and the OpenCode Go doc on raw.githubusercontent.com (model-discovery/opencode-go-catalog.service.ts:24), which is exactly the ADR 0003 list. The CIMD fetch, email, social login and S3 rows are correct. No phone-home destination exists that the page leaves out.
  • Defaults: recording retention 30 (config/recording-retention.ts:6), rate limits 200/500/10 (proxy-rate-limiter.ts), PROVIDER_TIMEOUT_MS 180000, STREAM_WARMUP_MS 15000 and CODEX_SEMANTIC_OUTPUT_TIMEOUT_MS 60000 all match the code.
  • Error codes: M001-M006 and M200-M203 exist in common/errors/ and the docs describe them correctly.
  • Code change: in crypto.util.ts only the error string and doc comment change. The recipe it now points to works: THINKER_ENCRYPTION_KEY_PREVIOUS is only checked for length, so it may equal BETTER_AUTH_SECRET. The spec covers the new message. No key-handling behavior changed, so the crypto high-risk criterion does not apply.
  • Attribution and license: README says MIT and credits mnfst/llm-gateway at manifest@6.28.6 with "copyright MNFST, Inc.". LICENSE keeps both copyright lines, which satisfies the MIT notice requirement.
  • Links: a relative-link scan of every *.md found no broken links. The anchor instalacao-docker.md#rotação-da-chave-de-cifragem exists.
  • Deleted files: none of the deleted files is still referenced. The logo-dark.svg hits are only substring matches of thinker-logo-dark.svg. provider-params-spec.ts was updated for the moved docs/dev/model-parameters-schema.md.
  • Project rules: the changeset is present, the title is a Conventional Commit, and no new manifest/MANIFEST_* identifiers are added (only historical "Quem vem do Manifest" text). No governance files or workflows are touched; the PR only deletes .github/assets images.

Nits

  1. docs/usuario/privacidade.md (OAuth row): for Copilot the page lists only api.github.com, but the device flow also calls github.com/login/device/code and github.com/login/oauth/access_token (routing/oauth/copilot/copilot-device-auth.service.ts:4-5). Suggested fix: list github.com and api.github.com.
  2. The same row could also mention chatgpt.com (Codex inference) for completeness. It is already covered by "APIs dos provedores conectados", so this is optional.

CI on the reviewed SHA

At the time of this review, CI on this SHA was still running: Changeset check, dependency-review and CodeQL (actions) were green, and the rest was queued or in progress for more than 30 minutes because of runner contention. The green-CI gate must be confirmed before merge. qa-docker is not required: the only runtime change is the text of a boot error message, which the unit spec covers.

Head revisado: ab043de
Veredito: aprovado

@patrickbrandao
patrickbrandao marked this pull request as ready for review October 14, 2026 15:08
@patrickbrandao
patrickbrandao merged commit 7a137dd into main Oct 14, 2026
19 checks passed
@patrickbrandao
patrickbrandao deleted the docs/ptbr-docs branch October 14, 2026 15:08
patrickbrandao added a commit that referenced this pull request Oct 14, 2026
…#169)

The Copilot device flow also calls github.com/login/device/code and
github.com/login/oauth/access_token (copilot-device-auth.service.ts).
Review nit from #166.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant