Repository navigation
docs: PT-BR user docs, developer guide and 0.1.0 upgrade notes - #166
Merged
Merged
Conversation
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>
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
Nits
CI on the reviewed SHAAt 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 |
patrickbrandao
marked this pull request as ready for review
October 14, 2026 15:08
This was referenced Oct 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #33
Closes #32
Closes #152
Part of #158
What changed
.github/assetsremoved). Newdocs/usuario/:instalacao-docker,configuracao(every env var checked against the code),primeiros-passos,conectar-harnesses(Claude Code, Codex, OpenCode, OpenClaw/Hermes, SDKs; snippets taken frompackages/shared/src/setup-snippets.ts),provedores-e-roteamento(default tier needed forauto, complexity routing, fallback),cli,solucao-de-problemas(M-codes, links todocs/erros.md),privacidade(ADR 0003 list plus CIMD),deploy-comunidade(marked untested).docker/DOCKER_README.mdis now a short PT-BR page.docs/dev/guia.md(architecture, commands,test:e2e:docker, migrations, auth, routing, recordings, CI, releases, merge policy, agents) anddocs/dev/terminologia.md(translated glossary, Autofix removed).docs/dev/manifest-guide.mdandmanifest-agents.mdare now short pointers becauseCLAUDE.mdandbackend-dev.mdstill link to them.AGENTS.mdupdated.docs/glossary.mdremoved.docs/releases/0.1.0.mdgains 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.shcomment fixed,.env.exampleretention default corrected (30, not 365),crypto.util.tsdoc comment updated and the missing-key boot error now points at the recipe (spec added).DOCKER_README.mdand in.env.example.Not in this PR
CLAUDE.mdis untouched (governance).CONTRIBUTING.md,SECURITY.md,CODE_OF_CONDUCT.md,dashboard-redesign-brief.md,docs/db-footprint-evaluation.md(+ script),docs/model-parameters-schema.mdmove, the translation ofdocs/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.tsin packages/backend: 51 passedtsc -p tsconfig.test.json --noEmit(backend): cleanvitest run tests/brand-assets.test.ts(frontend): 24 passednode scripts/check-changesets.js: OKqa-docker is not needed (docs plus one error-message string).
🤖 Generated with Claude Code