feat(docs): update documentation structure and content#1882
feat(docs): update documentation structure and content#1882cecilia-marques merged 4 commits intomainfrom
Conversation
|
Warning Rate limit exceeded@cecilia-marques has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 34 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (3)
WalkthroughReorganizes and localizes documentation: adds new full-code and no-code guides (EN/PT-BR), removes many legacy guides/pages, rewrites Introduction (EN/PT-BR), changes sidebar ordering to folder-driven explicit orders, adds i18n keys and breadcrumb locale lookup, and introduces a deterministic navigation ordering. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User / Browser
participant RD as RenderDocument.astro
participant I18n as i18n/ui.ts
participant Nav as navigation.ts
participant SB as Sidebar.astro
U->>RD: request render(doc.id)
RD->>RD: locale := first segment of doc.id
RD->>I18n: load ui[locale] or ui.en
I18n-->>RD: translations
RD->>RD: build breadcrumb with translations[`sidebar.section.${segment}`] || Capitalize(segment)
RD-->>U: render page (localized breadcrumb)
U->>SB: load sidebar (passes doc.id)
SB->>Nav: getNavigationLinks(locale from doc.id)
Nav->>Nav: apply explicit order array → folder-priority rules → alphabetical fallback
Nav-->>SB: ordered links
SB-->>U: render sidebar
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Deploying decocms-admin-frontend with
|
| Latest commit: |
d15e062
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://ed594368.admin-decocms-frontend.pages.dev |
| Branch Preview URL: | https://chore-update-docs.admin-decocms-frontend.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (10)
docs/view/src/components/ui/RenderDocument.astro (1)
27-44: Harden locale extraction and markdownPath constructionThe new breadcrumb/i18n logic is solid, but a couple of small tweaks would make it more robust and self-consistent:
- Avoid splitting
doc.idtwice and add a locale fallbackRight now
doc.idis split twice, andlocaleis cast as a ui key even if the first segment doesn’t match. You can derive bothlocaleandpathPartsonce and fall back to English when needed:-// Extract breadcrumb from the path -const pathParts = doc.id.split("/").slice(1); -const locale = doc.id.split("/")[0] as keyof typeof ui; -const translations = ui[locale] || ui.en; +// Extract locale and breadcrumb path from id +const [maybeLocale, ...pathParts] = doc.id.split("/"); +const locale = + (maybeLocale in ui ? maybeLocale : "en") as keyof typeof ui; +const translations = ui[locale] || ui.en;This also keeps
localeandpathPartsin sync if you ever change the id shape.
- Protect
markdownPathfrom double.mdxGiven other parts of the code (e.g., Sidebar) treat names with
.mdx, it’s safer to guard against a double extension:-const markdownPath = `/src/content/${doc.id}.mdx`; +const markdownPath = `/src/content/${ + doc.id.endsWith(".mdx") ? doc.id : `${doc.id}.mdx` +}`;This keeps the “view raw file” link correct regardless of whether
doc.idalready includes the extension.docs/view/src/content/pt-br/getting-started/ai-builders.mdx (1)
121-126: Optional: localize “follow-ups” to PortugueseThe section “Lembretes e follow-ups automatizados” is understandable, but “follow-ups” stands out as an unnecessary anglicism in an otherwise PT-BR page.
If you want to keep terminology fully localized, consider something like:
Lembretes e acompanhamentos automatizados
orLembretes e continuações automatizadasPurely stylistic; no functional impact.
docs/view/src/components/ui/Sidebar.astro (1)
59-108: Extract custom order arrays and folder priorities for clarityThe custom ordering (introduction first, then ordered files in
no-code-guides/full-code-guides, and folder priority forgetting-started→no-code-guides→full-code-guides) looks logically sound, given siblings share the same parent.To simplify maintenance and avoid re-allocating arrays on every comparison, consider hoisting the order definitions and using a small helper:
const noCodeOrder = ["creating-tools.mdx", "creating-agents.mdx"] as const; const fullCodeOrder = [ "project-structure.mdx", "building-tools.mdx", "building-views.mdx", "resources.mdx", "deployment.mdx", ] as const; const folderOrder = ["getting-started", "no-code-guides", "full-code-guides"] as const; function compareByOrder(nameA: string, nameB: string, order: readonly string[]) { const aIndex = order.indexOf(nameA); const bIndex = order.indexOf(nameB); if (aIndex === -1 && bIndex === -1) return 0; if (aIndex === -1) return 1; if (bIndex === -1) return -1; return aIndex - bIndex; }Then in the comparator you can delegate to
compareByOrderfor both files and folders, which makes future reordering less error-prone.docs/view/src/content/en/full-code-guides/building-tools.mdx (1)
129-129: External integrations documentation is clear.The explanation that integrations are accessed via
env["integration-id"]where the ID comes from the Apps section is helpful. Consider adding a tip that lists where users can find this ID (e.g., "in the Apps section of your workspace").docs/view/src/content/en/getting-started/context-engineers.mdx (1)
84-84: Simplify redundant phrasing for conciseness.Line 84 reads: "you'll need to install it globally using
npm i -g deco-cli@latestin order to get access to deco commands"Consider: "you'll need to install it globally using
npm i -g deco-cli@latestto access deco commands"docs/view/src/content/pt-br/getting-started/context-engineers.mdx (1)
85-85: Simplify wordy Portuguese phrasing for conciseness.Two instances can be more concise:
- Line 85: "dentro de uma pasta de projeto deco" → "em uma pasta de projeto deco" or "numa pasta de projeto deco"
- Line 89: "dentro de uma organização" → "em uma organização" or "numa organização"
These are stylistic improvements for brevity in Portuguese.
Also applies to: 89-89
docs/view/src/content/en/full-code-guides/building-views.mdx (1)
118-184: Theme tokens pattern is well-documented but note Tailwind v4 requires CSS configuration.The documentation correctly shows accessing theme tokens via CSS custom properties (e.g.,
var(--primary)). However, note that Tailwind CSS v4.0 shifts from configuring your project in JavaScript to configuring it in CSS, with customizations directly in the CSS file where you import Tailwind. The current description assumes tokens are pre-configured. Consider adding a brief note that these tokens should be defined in the CSS theme configuration using the@themedirective.docs/view/src/content/pt-br/introduction.mdx (3)
3-3: Address language conciseness on line 11.The static analysis tool flags line 11 suggesting the phrase "através de colaboração" could be more concise for clarity. Consider using "por" or restructuring to tighten the language.
Suggested revision:
-**Deco CMS** é um Sistema de Gerenciamento de Contexto open-source, o MCP Mesh para IA. Ele permite que equipes construam, implantem e gerenciem aplicações nativas de IA através de colaboração única entre usuários de negócios e desenvolvedores. +**Deco CMS** é um Sistema de Gerenciamento de Contexto open-source, o MCP Mesh para IA. Ele permite que equipes construam, implantem e gerenciem aplicações nativas de IA pela colaboração única entre usuários de negócios e desenvolvedores.Also applies to: 9-15
28-45: Address grammar and punctuation issues in architecture section.Static analysis flagged three potential issues in this section:
Line 34: Possible number agreement error. Verify the verb-noun agreement: "Exponha Virtual MCPs governados" should maintain consistent number and gender agreement with the predicate.
Line 38: The locution before the subsection should be separated by a comma for clarity:
-**Obtenha observabilidade completa** em toda a stack ### 2. AI App Framework (Virtual MCPs no Mesh) +**Obtenha observabilidade completa** em toda a stack. ### 2. AI App Framework (Virtual MCPs no Mesh)
- Line 40: Possible gender agreement issue. Review "Construa software web nativo de IA que chama tools" for consistent subject-verb-object agreement.
1-134: Overall: Strong documentation restructuring with aligned terminology and clear structure.This introduction effectively reframes Deco CMS around the new MCP Mesh and AI App Framework architecture, with clear persona-based value propositions and a logical information hierarchy. The content successfully bridges business users (AI Builders) and developers (Context Engineers).
Key strengths:
- New architectural framing is consistent and well-explained
- Building blocks (Tools, Agents, Workflows, etc.) are clearly documented
- Code examples are helpful and follow good practices
- Navigation structure supports both user personas
Recommendations:
- Address the optional language refinements flagged by static analysis (conciseness on line 11, grammar on lines 34, 38, 40)
- Verify the tool creation API example reflects the current implementation
- Confirm onboarding route links exist in the documentation structure
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
bun.lockbis excluded by!**/bun.lockb
📒 Files selected for processing (46)
docs/view/src/components/ui/RenderDocument.astro(1 hunks)docs/view/src/components/ui/Sidebar.astro(1 hunks)docs/view/src/content/en/bounties.mdx(0 hunks)docs/view/src/content/en/full-code-guides/building-tools.mdx(1 hunks)docs/view/src/content/en/full-code-guides/building-views.mdx(1 hunks)docs/view/src/content/en/full-code-guides/deployment.mdx(1 hunks)docs/view/src/content/en/full-code-guides/project-structure.mdx(1 hunks)docs/view/src/content/en/full-code-guides/resources.mdx(1 hunks)docs/view/src/content/en/getting-started.mdx(0 hunks)docs/view/src/content/en/getting-started/ai-builders.mdx(1 hunks)docs/view/src/content/en/getting-started/context-engineers.mdx(1 hunks)docs/view/src/content/en/guides/building-views.mdx(0 hunks)docs/view/src/content/en/guides/building-workflows.mdx(0 hunks)docs/view/src/content/en/guides/creating-tools.mdx(0 hunks)docs/view/src/content/en/guides/deconfig-realtime.mdx(0 hunks)docs/view/src/content/en/guides/deployment.mdx(0 hunks)docs/view/src/content/en/guides/integrations.mdx(0 hunks)docs/view/src/content/en/introduction.mdx(1 hunks)docs/view/src/content/en/no-code-guides/creating-agents.mdx(1 hunks)docs/view/src/content/en/no-code-guides/creating-tools.mdx(1 hunks)docs/view/src/content/en/project-structure.mdx(0 hunks)docs/view/src/content/en/reference/faq.mdx(0 hunks)docs/view/src/content/en/reference/resources.mdx(0 hunks)docs/view/src/content/pt-br/bounties.mdx(0 hunks)docs/view/src/content/pt-br/full-code-guides/building-tools.mdx(1 hunks)docs/view/src/content/pt-br/full-code-guides/building-views.mdx(1 hunks)docs/view/src/content/pt-br/full-code-guides/deployment.mdx(1 hunks)docs/view/src/content/pt-br/full-code-guides/project-structure.mdx(1 hunks)docs/view/src/content/pt-br/full-code-guides/resources.mdx(1 hunks)docs/view/src/content/pt-br/getting-started.mdx(0 hunks)docs/view/src/content/pt-br/getting-started/ai-builders.mdx(1 hunks)docs/view/src/content/pt-br/getting-started/context-engineers.mdx(1 hunks)docs/view/src/content/pt-br/guides/building-views.mdx(0 hunks)docs/view/src/content/pt-br/guides/building-workflows.mdx(0 hunks)docs/view/src/content/pt-br/guides/creating-tools.mdx(0 hunks)docs/view/src/content/pt-br/guides/deconfig-realtime.mdx(0 hunks)docs/view/src/content/pt-br/guides/deployment.mdx(0 hunks)docs/view/src/content/pt-br/guides/integrations.mdx(0 hunks)docs/view/src/content/pt-br/introduction.mdx(1 hunks)docs/view/src/content/pt-br/no-code-guides/creating-agents.mdx(1 hunks)docs/view/src/content/pt-br/no-code-guides/creating-tools.mdx(1 hunks)docs/view/src/content/pt-br/project-structure.mdx(0 hunks)docs/view/src/content/pt-br/reference/faq.mdx(0 hunks)docs/view/src/content/pt-br/reference/resources.mdx(0 hunks)docs/view/src/i18n/ui.ts(2 hunks)docs/view/src/utils/navigation.ts(1 hunks)
💤 Files with no reviewable changes (22)
- docs/view/src/content/en/guides/building-views.mdx
- docs/view/src/content/pt-br/getting-started.mdx
- docs/view/src/content/pt-br/bounties.mdx
- docs/view/src/content/en/guides/deployment.mdx
- docs/view/src/content/en/bounties.mdx
- docs/view/src/content/en/guides/deconfig-realtime.mdx
- docs/view/src/content/pt-br/guides/building-views.mdx
- docs/view/src/content/en/project-structure.mdx
- docs/view/src/content/en/guides/creating-tools.mdx
- docs/view/src/content/pt-br/guides/deployment.mdx
- docs/view/src/content/pt-br/guides/deconfig-realtime.mdx
- docs/view/src/content/pt-br/reference/faq.mdx
- docs/view/src/content/en/guides/integrations.mdx
- docs/view/src/content/en/getting-started.mdx
- docs/view/src/content/en/reference/faq.mdx
- docs/view/src/content/pt-br/guides/integrations.mdx
- docs/view/src/content/pt-br/project-structure.mdx
- docs/view/src/content/en/reference/resources.mdx
- docs/view/src/content/pt-br/guides/creating-tools.mdx
- docs/view/src/content/en/guides/building-workflows.mdx
- docs/view/src/content/pt-br/reference/resources.mdx
- docs/view/src/content/pt-br/guides/building-workflows.mdx
🧰 Additional context used
🪛 LanguageTool
docs/view/src/content/pt-br/no-code-guides/creating-agents.mdx
[style] ~9-~9: Para conferir mais clareza ao seu texto, busque usar uma linguagem mais concisa.
Context: ...tools, tomar decisões e manter contexto através de conversas. ## Entendendo Agents Cada ...
(ATRAVES_DE_POR_VIA)
[locale-violation] ~80-~80: “expertise” é um estrangeirismo. É preferível dizer “especialização”, “perícia”, “experiência”, “domínio” ou “competência”.
Context: ... Conhecimento de domínio - Áreas de expertise Exemplo de system prompt: ``` Você...
(PT_BARBARISMS_REPLACE_EXPERTISE)
[locale-violation] ~143-~143: “Performance” é um estrangeirismo. É preferível dizer “desempenho”, “atuação”, “apresentação”, “espetáculo” ou “interpretação”.
Context: ...s | $$$ | Lento | | Claude 3.5 Sonnet | Performance balanceada, conversas longas | $$ | Ráp...
(PT_BARBARISMS_REPLACE_PERFORMANCE)
[uncategorized] ~237-~237: Esta conjunção deve ser separada por vírgulas e só deve ser utilizada no início duma frase para efeitos de estilo.
Context: ...nter na memória - Janela maior = melhor contexto mas maior custo Controle de Acesso - C...
(VERB_COMMA_CONJUNCTION)
[locale-violation] ~278-~278: “follow-up” é um estrangeirismo. É preferível dizer “continuação” ou “acompanhamento”.
Context: ...ção faltando** - Agent faz perguntas de follow-up 3. Erros - Tools falham, agent lida...
(PT_BARBARISMS_REPLACE_FOLLOW_UP)
[locale-violation] ~288-~288: “performance” é um estrangeirismo. É preferível dizer “desempenho”, “atuação”, “apresentação”, “espetáculo” ou “interpretação”.
Context: ... ## Monitorando Uso do Agent Rastreie performance e uso do agent: - Vá em Uso na sua...
(PT_BARBARISMS_REPLACE_PERFORMANCE)
[grammar] ~298-~298: Possível erro de concordância de número.
Context: ...os de uso inesperados - Melhorar system prompts baseado em padrões reais Lembre-se: Os mel...
(GENERAL_NUMBER_AGREEMENT_ERRORS)
docs/view/src/content/pt-br/no-code-guides/creating-tools.mdx
[uncategorized] ~85-~85: Se “Por que” expressar uma explicação, considere escrever “porque”.
Context: ...alifyLead, calculate-order-total ``` Por que isso importa: Agents usam nomes de to...
(POR_QUE_PORQUE)
[grammar] ~85-~85: Deve-se usar a próclise quando o verbo for precedido imediatamente por palavras de negação e determinados pronomes, conjunções e advérbios.
Context: ...usam nomes de tools para decidir quando usá-los. Nomes descritivos = melhores decisões....
(COLOCACAO_PRONOMINAL_COM_ATRATOR_SIMPLES)
[uncategorized] ~85-~85: Se “Por que” expressar uma interrogação, considere utilizar “?”.
Context: ...mes de tools para decidir quando usá-los. Nomes descritivos = melhores decisões. ...
(POR_QUE_PORQUE)
[grammar] ~89-~89: Deve-se usar a próclise quando o verbo for precedido imediatamente por palavras de negação e determinados pronomes, conjunções e advérbios.
Context: ...s e workflows o que o tool faz e quando usá-lo: ``` Bom: "Qualificar um lead baseado n...
(COLOCACAO_PRONOMINAL_COM_ATRATOR_SIMPLES)
[style] ~97-~97: Num contexto formal, adicione “for"/"forem” para explicitar a condição.
Context: ...m: "Qualifica leads" ``` Quanto melhor a descrição, melhor os agents entendem qu...
(QUANTO_FOR)
[grammar] ~97-~97: Deve-se usar a próclise quando o verbo for precedido imediatamente por palavras de negação e determinados pronomes, conjunções e advérbios.
Context: ...rição, melhor os agents entendem quando usá-lo. ### 3. Input Schema Define quais par...
(COLOCACAO_PRONOMINAL_COM_ATRATOR_SIMPLES)
docs/view/src/content/pt-br/getting-started/ai-builders.mdx
[locale-violation] ~125-~125: “follow-ups” é um estrangeirismo. É preferível dizer “continuações” ou “acompanhamentos”.
Context: ...recuperação de documentos - Lembretes e follow-ups automatizados ### Processamento de Dad...
(PT_BARBARISMS_REPLACE_FOLLOW_UPS)
[typographical] ~135-~135: Símbolo sem par: “]” aparentemente está ausente
Context: ...er Ajuda: - Acesse nossa comunidade no Discord --...
(UNPAIRED_BRACKETS)
docs/view/src/content/pt-br/full-code-guides/project-structure.mdx
[uncategorized] ~66-~66: Se é uma abreviatura, falta um ponto. Se for uma expressão, coloque entre aspas.
Context: ...fina tool em server/tools/ 2. Execute npm run gen:self para gerar tipos 3. Chame `client...
(ABREVIATIONS_PUNCTUATION)
[locale-violation] ~72-~72: “server” é um estrangeirismo. É preferível dizer “servidor”.
Context: ... sem código de integração. ## Backend (/server) Seu Cloudflare Worker serve: - **`/m...
(PT_BARBARISMS_REPLACE_SERVER)
[uncategorized] ~105-~105: Encontrada possível ausência de vírgula.
Context: ...p. Estenda com campos customizados para API keys, configurações de ambiente, etc. ...
(AI_PT_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~158-~158: Esta é uma palavra só.
Context: ..., }, ]; ### `deco.gen.ts` Tipos auto-gerados. Nunca edite manualmente. bash npm ...
(AUTO)
[misspelling] ~183-~183: Esta é uma palavra só.
Context: ...l` Configuração do Cloudflare Workers. Auto-atualizado ao adicionar integrações. ## Frontend ...
(AUTO)
[locale-violation] ~187-~187: “Router” é um estrangeirismo. É preferível dizer “encaminhador” ou “roteador”.
Context: ...ew`) React 19 + Tailwind v4 + TanStack Router. ``` view/src/ ├── main.tsx # ...
(PT_BARBARISMS_REPLACE_ROUTER)
[misspelling] ~200-~200: Esta é uma palavra só.
Context: ... ### Cliente RPC O cliente rpc.ts é auto-gerado dos seus tools do backend: ```typescri...
(AUTO)
[grammar] ~222-~222: Se ‘inputs’ é um substantivo, ‘todos’ no plural exige um segundo artigo.
Context: ...utocomplete e verificação de tipos para todos inputs/outputs de tools. Veja [Construindo Vi...
(TODOS_FOLLOWED_BY_NOUN_PLURAL)
docs/view/src/content/en/getting-started/context-engineers.mdx
[style] ~84-~84: Consider a more concise word here.
Context: ...obally using npm i -g deco-cli@latest in order to get access to deco commands **2. Singl...
(IN_ORDER_TO_PREMIUM)
docs/view/src/content/pt-br/full-code-guides/building-tools.mdx
[locale-violation] ~177-~177: “server” é um estrangeirismo. É preferível dizer “servidor”.
Context: ...## Registrando Tools Adicione tools em server/main.ts: ```typescript import { withR...
(PT_BARBARISMS_REPLACE_SERVER)
[uncategorized] ~198-~198: Se é uma abreviatura, falta um ponto. Se for uma expressão, coloque entre aspas.
Context: ...lt runtime; ``` Após registro, execute npm run gen:self para gerar tipos para seu fronten...
(ABREVIATIONS_PUNCTUATION)
[misspelling] ~208-~208: Esta é uma palavra só.
Context: ...p`) 4. Teste tools através da interface auto-gerada 2. Via Código: ```typescript // No...
(AUTO)
docs/view/src/content/pt-br/full-code-guides/resources.mdx
[misspelling] ~20-~20: Esta é uma palavra só.
Context: ...fina um schema de resource → Tools CRUD auto-gerados → Cliente frontend type-safe → Atualiza...
(AUTO)
[locale-violation] ~26-~26: “Server” é um estrangeirismo. É preferível dizer “servidor”.
Context: ... via URIs rsc:// - Tempo real com Server-Sent Events --- ## Definir um Resourc...
(PT_BARBARISMS_REPLACE_SERVER)
[locale-violation] ~32-~32: “server” é um estrangeirismo. É preferível dizer “servidor”.
Context: ... Definir um Resource Crie um schema em server/tools/: ```typescript import { Deconf...
(PT_BARBARISMS_REPLACE_SERVER)
[misspelling] ~72-~72: Esta é uma palavra só.
Context: .../resource-id Oresource-id` pode ser auto-gerado ou você pode especificá-lo no CREATE: ...
(AUTO)
[uncategorized] ~83-~83: Se é uma abreviatura, falta um ponto. Se for uma expressão, coloque entre aspas.
Context: ...``` ## Usar no Frontend Após executar npm run gen:self, use o cliente gerado: ### Opera...
(ABREVIATIONS_PUNCTUATION)
[uncategorized] ~307-~307: Encontrada possível ausência de vírgula.
Context: ...ault()` - Valide formatos estritamente (cores hex, emails, URLs) ## Opções Avançadas...
(AI_PT_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~418-~418: Pontuação duplicada
Context: .../ Outros erros } } ``` Erros comuns: - NotFoundError: URI de resource não existe - `Validatio...
(DOUBLE_PUNCTUATION_XML)
[locale-violation] ~423-~423: “Performance” é um estrangeirismo. É preferível dizer “desempenho”, “atuação”, “apresentação”, “espetáculo” ou “interpretação”.
Context: ...m ID já existe (no CREATE) ## Dicas de Performance Paginação: ```typescript // Ruim: ...
(PT_BARBARISMS_REPLACE_PERFORMANCE)
[uncategorized] ~472-~472: Pontuação duplicada
Context: ...n: string, }, }, }) ``` Retorna: - create(env): Função para registrar tools de resource...
(DOUBLE_PUNCTUATION_XML)
docs/view/src/content/pt-br/introduction.mdx
[style] ~11-~11: Para conferir mais clareza ao seu texto, busque usar uma linguagem mais concisa.
Context: ...em e gerenciem aplicações nativas de IA através de colaboração única entre usuários de neg...
(ATRAVES_DE_POR_VIA)
[grammar] ~34-~34: Possível erro de concordância de número.
Context: ...- Exponha Virtual MCPs governados ("AI Apps") para qualquer cliente MCP - **Aplique...
(GENERAL_NUMBER_AGREEMENT_ERRORS)
[uncategorized] ~38-~38: Esta locução deve ser separada por vírgulas.
Context: ...e completa** em toda a stack ### 2. AI App Framework (Virtual MCPs no Mesh) Const...
(VERB_COMMA_CONJUNCTION)
[grammar] ~40-~40: Possível erro de concordância.
Context: ...mework (Virtual MCPs no Mesh) Construa software web nativo de IA que chama tools: - **Full...
(GENERAL_GENDER_AGREEMENT_ERRORS)
[typographical] ~133-~133: Símbolo sem par: “[” aparentemente está ausente
Context: ...olha seu caminho: - Para AI Builders -...
(UNPAIRED_BRACKETS)
[typographical] ~134-~134: Símbolo sem par: “[” aparentemente está ausente
Context: ...a sem código - **[Para Context Engineers](/pt-br/getting-started/context-engineer...
(UNPAIRED_BRACKETS)
docs/view/src/content/pt-br/getting-started/context-engineers.mdx
[uncategorized] ~11-~11: Pontuação duplicada
Context: ...equisitos - Node.js v22+ (download) - Git - Editor de código ([Curs...
(DOUBLE_PUNCTUATION_XML)
[uncategorized] ~14-~14: Pontuação duplicada
Context: ...ndado) - Básico de TypeScript (docs) ## Configuração Inicial ### Crie Seu ...
(DOUBLE_PUNCTUATION_XML)
[typographical] ~45-~45: Símbolo sem par: “]” aparentemente está ausente
Context: ... ### Teste Seu Servidor MCP 1. Vá para [admin.decocms.com](https://admin.decocms...
(UNPAIRED_BRACKETS)
[locale-violation] ~48-~48: “template” é um estrangeirismo. É preferível dizer “modelo”.
Context: ...alve e teste os tools padrão que vêm do template ### Deploy Quando estiver pronto para...
(PT_BARBARISMS_REPLACE_TEMPLATE)
[uncategorized] ~62-~62: Quando não estão acompanhadas de vocativo, as interjeições devem ser finalizadas com pontos de exclamação ou interrogação. Quando houver vocativo, deve usar a vírgula. Para indicar hesitação ou prolongamento de ideias, utilize as reticências.
Context: ... apps de IA usando deco: 1. Plataforma/UI - Construa em [admin.decocms.com](http...
(INTERJECTIONS_PUNTUATION)
[typographical] ~62-~62: Símbolo sem par: “]” aparentemente está ausente
Context: ...eco: 1. Plataforma/UI - Construa em [admin.decocms.com](https://admin.decocms...
(UNPAIRED_BRACKETS)
[style] ~85-~85: “dentro de uma” é uma expressão prolixa. É preferível dizer “numa” ou “em uma”.
Context: ... ``` Nota: Se você não está dentro de uma pasta de projeto deco ou não inicializo...
(PT_WORDINESS_REPLACE_DENTRO_DE_UMA)
[style] ~89-~89: “dentro de uma” é uma expressão prolixa. É preferível dizer “numa” ou “em uma”.
Context: ...)** Trabalhe com um projeto específico dentro de uma organização: ```bash # Exporte um proj...
(PT_WORDINESS_REPLACE_DENTRO_DE_UMA)
[typographical] ~109-~109: Símbolo sem par: “]” aparentemente está ausente
Context: ... e código. Obter Ajuda: Discord *...
(UNPAIRED_BRACKETS)
docs/view/src/content/en/no-code-guides/creating-agents.mdx
[style] ~41-~41: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...uestions (What tools? What personality? What boundaries?) 2. Suggests a system promp...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~210-~210: Ensure spelling is correct
Context: ...ccess to tools that come with pre-built integrtions (apps). Here, add new integrations or s...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~238-~238: Consider using a more formal alternative.
Context: ...ell it to, it figures out when it needs more information. #### Database Context Give agents ac...
(MORE_INFO)
docs/view/src/content/pt-br/full-code-guides/deployment.mdx
[misspelling] ~89-~89: Esta é uma palavra só.
Context: ...am na localização edge mais próxima. Auto-scaling: Cloudflare lida com picos de tráfego...
(AUTO)
docs/view/src/content/pt-br/full-code-guides/building-views.mdx
[locale-violation] ~15-~15: “Router” é um estrangeirismo. É preferível dizer “encaminhador” ou “roteador”.
Context: ...d v4** - CSS utility-first - TanStack Router - Roteamento type-safe - Vite - B...
(PT_BARBARISMS_REPLACE_ROUTER)
[misspelling] ~61-~61: Esta é uma palavra só.
Context: ... API** - Chamadas de função diretas - Auto-complete - IDE sugere tools disponíveis Execu...
(AUTO)
[uncategorized] ~63-~63: Se é uma abreviatura, falta um ponto. Se for uma expressão, coloque entre aspas.
Context: ...- IDE sugere tools disponíveis Execute npm run gen:self após adicionar tools para atualiz...
(ABREVIATIONS_PUNCTUATION)
[locale-violation] ~67-~67: “Router” é um estrangeirismo. É preferível dizer “encaminhador” ou “roteador”.
Context: ... tipos. ## Adicionando Rotas TanStack Router provê roteamento type-safe. Para adicio...
(PT_BARBARISMS_REPLACE_ROUTER)
[uncategorized] ~116-~116: Quando não estão acompanhadas de vocativo, as interjeições devem ser finalizadas com pontos de exclamação ou interrogação. Quando houver vocativo, deve usar a vírgula. Para indicar hesitação ou prolongamento de ideias, utilize as reticências.
Context: ...Clique aqui ``` Use src/components/ui/ para componentes reutilizáveis (botões...
(INTERJECTIONS_PUNTUATION)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (27)
docs/view/src/content/pt-br/no-code-guides/creating-agents.mdx (1)
1-300: LGTM! Comprehensive agent creation guide in Portuguese.The documentation is well-structured, covering key concepts from basic understanding through advanced configuration. The examples are clear and the progressive disclosure approach (starting with chat-based creation, then explaining mechanics) is effective for both beginners and advanced users.
docs/view/src/content/en/no-code-guides/creating-tools.mdx (1)
1-238: LGTM! Excellent comprehensive tool creation guide.The documentation effectively covers the full lifecycle from understanding tools through creation, testing, and management. The progressive disclosure pattern and practical examples make it accessible to non-technical users while providing depth for those who need it.
docs/view/src/content/pt-br/no-code-guides/creating-tools.mdx (1)
1-185: LGTM! Well-structured Portuguese tool creation guide.The documentation effectively mirrors the English version with appropriate localization. Content is clear and comprehensive.
docs/view/src/content/pt-br/full-code-guides/project-structure.mdx (1)
1-224: LGTM! Comprehensive Portuguese project structure guide.The documentation clearly explains the full-stack monorepo architecture with accurate references to React 19, Tailwind v4, and the backend/frontend integration patterns. The directory structure examples and code snippets effectively illustrate the architecture.
docs/view/src/content/pt-br/full-code-guides/building-views.mdx (1)
1-183: LGTM! Clear and practical React views guide in Portuguese.The documentation provides excellent practical guidance for building React 19 interfaces with typed RPC. The code examples are correct and follow React 19 best practices. The workflow explanation is clear and helpful.
docs/view/src/content/en/no-code-guides/creating-agents.mdx (1)
1-346: Excellent comprehensive agent creation guide.Besides the minor typo on line 210, the documentation is thorough, well-structured, and provides excellent guidance for both beginners and advanced users. The system prompt examples are particularly valuable.
docs/view/src/content/en/introduction.mdx (1)
1-133: LGTM! Clear and improved introduction.The restructured content effectively communicates the two-layer architecture (MCP Mesh + AI App Framework) and provides a clearer value proposition. The code examples are accurate and the React 19 references are valid. The new organization improves readability and understanding.
docs/view/src/utils/navigation.ts (1)
16-49: LGTM! Clean and correct navigation ordering implementation.The explicit navigation order array combined with the three-tier sorting logic (ordered items by position, then unordered items alphabetically) provides clear, maintainable control over documentation navigation. The implementation correctly handles path extraction and comparisons.
docs/view/src/content/en/getting-started/ai-builders.mdx (1)
7-90: Well-structured step-by-step flowThe imports, MDX structure, and step flow (App Store → chat test → reusable automation) are consistent and clear. Nothing blocking from a docs or implementation perspective.
docs/view/src/i18n/ui.ts (1)
9-27: Sidebar section keys align with new docs structureThe new
sidebar.section.*keys match the folder names used for breadcrumbs (getting-started,no-code-guides,full-code-guides) and provide clear EN/PT-BR labels. This dovetails cleanly with the breadcrumb logic inRenderDocument.astro.docs/view/src/content/en/full-code-guides/deployment.mdx (1)
7-139: Deployment guide reads clearly and covers key flowsThe deployment doc gives a concise but complete path (CLI → auth → CI/CD → edge behavior → testing → rollbacks → env vars). Structurally it looks good and should integrate cleanly with the existing Callout component and docs navigation.
docs/view/src/content/en/full-code-guides/building-tools.mdx (2)
27-56: Code example structure is solid — includes comprehensive tool setup.The basic example clearly demonstrates the four required components (ID, description, schemas, execute) with proper error handling and environment integration. Good practice showing validated inputs via
contextand matching output schema.
12-12: Cross-reference is valid — no action needed.Verification confirms that
/en/no-code-guides/creating-toolsexists atdocs/view/src/content/en/no-code-guides/creating-tools.mdx. The callout on line 12 correctly points to an existing documentation page.docs/view/src/content/en/getting-started/context-engineers.mdx (2)
70-107: Bridging section clearly explains transition between UI and code workflows.The two options (Workspace Resources vs Single Project) with distinct use cases are well-articulated and practical. The note about global deco-cli installation and the Git-native sync callout are helpful context.
111-111: No issues found—cross-reference is valid.The AI Builders guide exists at
docs/view/src/content/en/getting-started/ai-builders.mdx, confirming the cross-reference at line 111 is correct.docs/view/src/content/en/full-code-guides/building-views.mdx (1)
65-100: React routing and component patterns are accurate for React 19.The TanStack Router examples and React component structure follow current best practices. Type safety is properly emphasized.
docs/view/src/content/pt-br/full-code-guides/resources.mdx (1)
1-50: Comprehensive deconfig resources guide — PT-BR translation is complete and accurate.The documentation clearly explains the resource system, CRUD operations, and real-time synchronization with good examples. Translation maintains technical accuracy.
docs/view/src/content/en/full-code-guides/resources.mdx (2)
1-100: Resources guide is comprehensive and well-structured with clear patterns.The CRUD operations table, basic examples, and SSE subscription patterns are clearly explained. Code examples follow React/TypeScript best practices and demonstrate real-world use cases like React Query integration.
282-301: Schema best practices section provides solid guidance.Recommendations on searchability,
.describe()documentation, defaults, and strict validation are practical and promote good design.docs/view/src/content/en/full-code-guides/project-structure.mdx (3)
15-61: Directory structure is clear and well-documented.The file tree effectively shows the monorepo layout with clear comments explaining each section. The server/view separation is well-illustrated.
79-105: Backend architecture section is concise and clear.The explanation of the three endpoints (
/mcp,/rpc,/) and the main.ts example with OAuth scopes and StateSchema setup provide good foundational understanding. The organization of tools by domain is a sound practice suggestion.
129-129: Cross-references verified—both guide files exist.The documentation correctly references
/en/full-code-guides/building-tools(line 129) and/en/full-code-guides/building-views(line 224), and both files are present in the repository structure.docs/view/src/content/pt-br/getting-started/context-engineers.mdx (1)
111-111: PT-BR cross-reference is valid.The localized AI Builders guide exists at
docs/view/src/content/pt-br/getting-started/ai-builders.mdx. The cross-reference to/pt-br/getting-started/ai-buildersis correct.docs/view/src/content/pt-br/full-code-guides/building-tools.mdx (1)
12-12: PT-BR cross-reference verified and valid.The localized page at
/pt-br/no-code-guides/creating-toolsexists in the documentation structure. The link is correctly formed and points to a valid resource.docs/view/src/content/pt-br/introduction.mdx (3)
62-80: Architecture building blocks sections are well-structured.The Agents, Workflows, and Views sections provide clear descriptions with good examples. The code samples are helpful and follow a consistent documentation style.
131-134: Verify markdown link syntax (likely false positive from static analysis).Static analysis flagged lines 133–134 for unpaired brackets, but these appear to be valid Markdown link syntax wrapped in bold formatting:
**[text](url)**. This is likely a false positive from the linting tool not recognizing Markdown-specific syntax.Please verify visually that the links render correctly in the documentation build, particularly ensuring:
- Both links point to valid routes in your documentation structure
- The URLs
/pt-br/getting-started/ai-buildersand/pt-br/getting-started/context-engineersexist in the site
52-60: No issues found — the tool creation API example is correct.The
executesignature shown in the documentation (async ({ context })) accurately reflects the current Deco CMS implementation. The execute function receives an object containing{ context, runId, runtimeContext }, and destructuring{ context }correctly extracts the input values defined byinputSchema. This pattern is consistently used across production examples, multiple language guides, and internal implementations.
- Removed outdated guides: `bounties.mdx`, `getting-started.mdx`, and `project-structure.mdx`. - Added new guides: `building-tools.mdx`, `building-views.mdx`, `deployment.mdx`, and `project-structure.mdx` to enhance clarity on tool creation and deployment processes. - Updated translations in `ui.ts` for improved navigation labels in both English and Portuguese. - Enhanced navigation logic in `navigation.ts` to ensure consistent ordering of documentation links.
cecilia-marques
force-pushed
the
chore/update-docs
branch
from
8a21bc4 to
8ccb2d2
Compare
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
docs/view/src/content/pt-br/full-code-guides/deployment.mdx (1)
126-132: Remove duplicated environment variable warning callout.Lines 126–132 contain two nearly identical
Calloutblocks warning about environment variables; this creates unnecessary duplication. Consolidate into a single, polished version.Apply this diff:
-<Callout type="warning"> - **Variáveis de ambiente:** Configure secrets de produção em `wrangler.toml` ou dashboard do Cloudflare. Nunca commite secrets no Git. -</Callout> - -<Callout type="warning"> - **Variáveis de ambiente:** Configure secrets de produção em `wrangler.toml` ou no dashboard do Cloudflare. Nunca commit secrets no Git. -</Callout> +<Callout type="warning"> + **Variáveis de ambiente:** Configure secrets de produção em `wrangler.toml` ou no dashboard do Cloudflare. Nunca commite secrets no Git. +</Callout>
🧹 Nitpick comments (6)
docs/view/src/content/pt-br/getting-started/context-engineers.mdx (1)
48-48: Replace English borrowing "template" with Portuguese "modelo".Line 48 uses "template" which should be replaced with the Portuguese term "modelo" for consistency with Portuguese language documentation standards.
Apply this diff:
-Salve e teste os tools padrão que vêm do template +Salve e teste os tools padrão que vêm do modelodocs/view/src/components/ui/Sidebar.astro (1)
61-109: Consider consolidating ordering logic to reduce duplication.The custom ordering logic here (lines 66-96 for file ordering within folders, lines 99-109 for folder ordering) duplicates navigation concerns already addressed in
docs/view/src/utils/navigation.ts(lines 17-28). While the implementations differ in structure, they serve similar purposes and must be kept in sync when navigation order changes.Consider extracting a shared ordering configuration that both files can consume, or reusing the navigation.ts ordering logic directly if feasible. This would reduce maintenance burden and prevent inconsistencies.
docs/view/src/content/pt-br/full-code-guides/project-structure.mdx (2)
72-72: Use Portuguese terminology instead of English loanwords in PT-BR documentation.Lines 72, 129 reference "server" (English); line 187 references "Router" (English). For Portuguese readers, consider using "servidor" and "roteador" respectively to align with Portuguese technical writing conventions.
Apply this diff for improved Portuguese terminology:
- ## Backend (`/server`) + ## Backend (`/servidor`)(Similar changes for line 129 link and line 187 Router reference.)
Also applies to: 129-129, 187-187
158-158: Standardize hyphenation of "auto-" prefix in Portuguese.LanguageTool flags "auto-gerados" (line 158), "Auto-atualizado" (line 183), and "auto-gerado" (line 200) as hyphenation inconsistencies. Portuguese technical writing may prefer these as single words or consistent compound forms. Verify against your style guide and standardize across all PT-BR docs.
Also applies to: 183-183, 200-200
docs/view/src/content/pt-br/full-code-guides/resources.mdx (2)
26-26: Use "servidor" instead of English "Server" in Portuguese documentation.Lines 26 and 32 reference "Server" and "server" respectively. For consistency with Portuguese technical terminology, use "servidor" to improve readability for PT-BR audience.
Also applies to: 32-32
423-423: Consider using Portuguese term for "Performance".Line 423 uses the English word "Performance" as a section header. For consistency with Portuguese documentation, consider translating to "Desempenho" or "Atuação".
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
bun.lockbis excluded by!**/bun.lockb
📒 Files selected for processing (46)
docs/view/src/components/ui/RenderDocument.astro(1 hunks)docs/view/src/components/ui/Sidebar.astro(1 hunks)docs/view/src/content/en/bounties.mdx(0 hunks)docs/view/src/content/en/full-code-guides/building-tools.mdx(1 hunks)docs/view/src/content/en/full-code-guides/building-views.mdx(1 hunks)docs/view/src/content/en/full-code-guides/deployment.mdx(1 hunks)docs/view/src/content/en/full-code-guides/project-structure.mdx(1 hunks)docs/view/src/content/en/full-code-guides/resources.mdx(1 hunks)docs/view/src/content/en/getting-started.mdx(0 hunks)docs/view/src/content/en/getting-started/ai-builders.mdx(1 hunks)docs/view/src/content/en/getting-started/context-engineers.mdx(1 hunks)docs/view/src/content/en/guides/building-views.mdx(0 hunks)docs/view/src/content/en/guides/building-workflows.mdx(0 hunks)docs/view/src/content/en/guides/creating-tools.mdx(0 hunks)docs/view/src/content/en/guides/deconfig-realtime.mdx(0 hunks)docs/view/src/content/en/guides/deployment.mdx(0 hunks)docs/view/src/content/en/guides/integrations.mdx(0 hunks)docs/view/src/content/en/introduction.mdx(1 hunks)docs/view/src/content/en/no-code-guides/creating-agents.mdx(1 hunks)docs/view/src/content/en/no-code-guides/creating-tools.mdx(1 hunks)docs/view/src/content/en/project-structure.mdx(0 hunks)docs/view/src/content/en/reference/faq.mdx(0 hunks)docs/view/src/content/en/reference/resources.mdx(0 hunks)docs/view/src/content/pt-br/bounties.mdx(0 hunks)docs/view/src/content/pt-br/full-code-guides/building-tools.mdx(1 hunks)docs/view/src/content/pt-br/full-code-guides/building-views.mdx(1 hunks)docs/view/src/content/pt-br/full-code-guides/deployment.mdx(1 hunks)docs/view/src/content/pt-br/full-code-guides/project-structure.mdx(1 hunks)docs/view/src/content/pt-br/full-code-guides/resources.mdx(1 hunks)docs/view/src/content/pt-br/getting-started.mdx(0 hunks)docs/view/src/content/pt-br/getting-started/ai-builders.mdx(1 hunks)docs/view/src/content/pt-br/getting-started/context-engineers.mdx(1 hunks)docs/view/src/content/pt-br/guides/building-views.mdx(0 hunks)docs/view/src/content/pt-br/guides/building-workflows.mdx(0 hunks)docs/view/src/content/pt-br/guides/creating-tools.mdx(0 hunks)docs/view/src/content/pt-br/guides/deconfig-realtime.mdx(0 hunks)docs/view/src/content/pt-br/guides/deployment.mdx(0 hunks)docs/view/src/content/pt-br/guides/integrations.mdx(0 hunks)docs/view/src/content/pt-br/introduction.mdx(1 hunks)docs/view/src/content/pt-br/no-code-guides/creating-agents.mdx(1 hunks)docs/view/src/content/pt-br/no-code-guides/creating-tools.mdx(1 hunks)docs/view/src/content/pt-br/project-structure.mdx(0 hunks)docs/view/src/content/pt-br/reference/faq.mdx(0 hunks)docs/view/src/content/pt-br/reference/resources.mdx(0 hunks)docs/view/src/i18n/ui.ts(2 hunks)docs/view/src/utils/navigation.ts(1 hunks)
💤 Files with no reviewable changes (22)
- docs/view/src/content/pt-br/getting-started.mdx
- docs/view/src/content/en/reference/resources.mdx
- docs/view/src/content/pt-br/guides/building-views.mdx
- docs/view/src/content/en/guides/integrations.mdx
- docs/view/src/content/en/guides/deployment.mdx
- docs/view/src/content/pt-br/guides/integrations.mdx
- docs/view/src/content/pt-br/guides/deconfig-realtime.mdx
- docs/view/src/content/pt-br/project-structure.mdx
- docs/view/src/content/en/guides/building-views.mdx
- docs/view/src/content/pt-br/bounties.mdx
- docs/view/src/content/en/guides/deconfig-realtime.mdx
- docs/view/src/content/pt-br/reference/resources.mdx
- docs/view/src/content/en/project-structure.mdx
- docs/view/src/content/pt-br/guides/deployment.mdx
- docs/view/src/content/en/guides/creating-tools.mdx
- docs/view/src/content/en/guides/building-workflows.mdx
- docs/view/src/content/pt-br/reference/faq.mdx
- docs/view/src/content/en/reference/faq.mdx
- docs/view/src/content/pt-br/guides/building-workflows.mdx
- docs/view/src/content/en/getting-started.mdx
- docs/view/src/content/pt-br/guides/creating-tools.mdx
- docs/view/src/content/en/bounties.mdx
✅ Files skipped from review due to trivial changes (1)
- docs/view/src/content/en/full-code-guides/building-tools.mdx
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/view/src/content/en/full-code-guides/resources.mdx
- docs/view/src/content/en/no-code-guides/creating-tools.mdx
- docs/view/src/content/en/full-code-guides/project-structure.mdx
🧰 Additional context used
🪛 LanguageTool
docs/view/src/content/pt-br/no-code-guides/creating-tools.mdx
[uncategorized] ~85-~85: Se “Por que” expressar uma explicação, considere escrever “porque”.
Context: ...alifyLead, calculate-order-total ``` Por que isso importa: Agents usam nomes de to...
(POR_QUE_PORQUE)
[grammar] ~85-~85: Deve-se usar a próclise quando o verbo for precedido imediatamente por palavras de negação e determinados pronomes, conjunções e advérbios.
Context: ...usam nomes de tools para decidir quando usá-los. Nomes descritivos = melhores decisões....
(COLOCACAO_PRONOMINAL_COM_ATRATOR_SIMPLES)
[uncategorized] ~85-~85: Se “Por que” expressar uma interrogação, considere utilizar “?”.
Context: ...mes de tools para decidir quando usá-los. Nomes descritivos = melhores decisões. ...
(POR_QUE_PORQUE)
[grammar] ~89-~89: Deve-se usar a próclise quando o verbo for precedido imediatamente por palavras de negação e determinados pronomes, conjunções e advérbios.
Context: ...s e workflows o que o tool faz e quando usá-lo: ``` Bom: "Qualificar um lead baseado n...
(COLOCACAO_PRONOMINAL_COM_ATRATOR_SIMPLES)
[style] ~97-~97: Num contexto formal, adicione “for"/"forem” para explicitar a condição.
Context: ...m: "Qualifica leads" ``` Quanto melhor a descrição, melhor os agents entendem qu...
(QUANTO_FOR)
[grammar] ~97-~97: Deve-se usar a próclise quando o verbo for precedido imediatamente por palavras de negação e determinados pronomes, conjunções e advérbios.
Context: ...rição, melhor os agents entendem quando usá-lo. ### 3. Input Schema Define quais par...
(COLOCACAO_PRONOMINAL_COM_ATRATOR_SIMPLES)
docs/view/src/content/pt-br/getting-started/context-engineers.mdx
[uncategorized] ~11-~11: Pontuação duplicada
Context: ...equisitos - Node.js v22+ (download) - Git - Editor de código ([Curs...
(DOUBLE_PUNCTUATION_XML)
[uncategorized] ~14-~14: Pontuação duplicada
Context: ...ndado) - Básico de TypeScript (docs) ## Configuração Inicial ### Crie Seu ...
(DOUBLE_PUNCTUATION_XML)
[typographical] ~45-~45: Símbolo sem par: “]” aparentemente está ausente
Context: ... ### Teste Seu Servidor MCP 1. Vá para [admin.decocms.com](https://admin.decocms...
(UNPAIRED_BRACKETS)
[locale-violation] ~48-~48: “template” é um estrangeirismo. É preferível dizer “modelo”.
Context: ...alve e teste os tools padrão que vêm do template ### Deploy Quando estiver pronto para...
(PT_BARBARISMS_REPLACE_TEMPLATE)
[uncategorized] ~62-~62: Quando não estão acompanhadas de vocativo, as interjeições devem ser finalizadas com pontos de exclamação ou interrogação. Quando houver vocativo, deve usar a vírgula. Para indicar hesitação ou prolongamento de ideias, utilize as reticências.
Context: ... apps de IA usando deco: 1. Plataforma/UI - Construa em [admin.decocms.com](http...
(INTERJECTIONS_PUNTUATION)
[typographical] ~62-~62: Símbolo sem par: “]” aparentemente está ausente
Context: ...eco: 1. Plataforma/UI - Construa em [admin.decocms.com](https://admin.decocms...
(UNPAIRED_BRACKETS)
[style] ~85-~85: “dentro de uma” é uma expressão prolixa. É preferível dizer “numa” ou “em uma”.
Context: ... ``` Nota: Se você não está dentro de uma pasta de projeto deco ou não inicializo...
(PT_WORDINESS_REPLACE_DENTRO_DE_UMA)
[style] ~89-~89: “dentro de uma” é uma expressão prolixa. É preferível dizer “numa” ou “em uma”.
Context: ...)** Trabalhe com um projeto específico dentro de uma organização: ```bash # Exporte um proj...
(PT_WORDINESS_REPLACE_DENTRO_DE_UMA)
[typographical] ~109-~109: Símbolo sem par: “]” aparentemente está ausente
Context: ... e código. Obter Ajuda: Discord *...
(UNPAIRED_BRACKETS)
docs/view/src/content/en/no-code-guides/creating-agents.mdx
[style] ~41-~41: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...uestions (What tools? What personality? What boundaries?) 2. Suggests a system promp...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[grammar] ~210-~210: Ensure spelling is correct
Context: ...ccess to tools that come with pre-built integrtions (apps). Here, add new integrations or s...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~238-~238: Consider using a more formal alternative.
Context: ...ell it to, it figures out when it needs more information. #### Database Context Give agents ac...
(MORE_INFO)
docs/view/src/content/pt-br/introduction.mdx
[style] ~11-~11: Para conferir mais clareza ao seu texto, busque usar uma linguagem mais concisa.
Context: ...em e gerenciem aplicações nativas de IA através de colaboração única entre usuários de neg...
(ATRAVES_DE_POR_VIA)
[grammar] ~34-~34: Possível erro de concordância de número.
Context: ...- Exponha Virtual MCPs governados ("AI Apps") para qualquer cliente MCP - **Aplique...
(GENERAL_NUMBER_AGREEMENT_ERRORS)
[uncategorized] ~38-~38: Esta locução deve ser separada por vírgulas.
Context: ...e completa** em toda a stack ### 2. AI App Framework (Virtual MCPs no Mesh) Const...
(VERB_COMMA_CONJUNCTION)
[grammar] ~40-~40: Possível erro de concordância.
Context: ...mework (Virtual MCPs no Mesh) Construa software web nativo de IA que chama tools: - **Full...
(GENERAL_GENDER_AGREEMENT_ERRORS)
[typographical] ~133-~133: Símbolo sem par: “[” aparentemente está ausente
Context: ...olha seu caminho: - Para AI Builders -...
(UNPAIRED_BRACKETS)
[typographical] ~134-~134: Símbolo sem par: “[” aparentemente está ausente
Context: ...a sem código - **[Para Context Engineers](/pt-br/getting-started/context-engineer...
(UNPAIRED_BRACKETS)
docs/view/src/content/pt-br/full-code-guides/deployment.mdx
[misspelling] ~89-~89: Esta é uma palavra só.
Context: ...am na localização edge mais próxima. Auto-scaling: Cloudflare lida com picos de tráfego...
(AUTO)
docs/view/src/content/pt-br/no-code-guides/creating-agents.mdx
[style] ~9-~9: Para conferir mais clareza ao seu texto, busque usar uma linguagem mais concisa.
Context: ...tools, tomar decisões e manter contexto através de conversas. ## Entendendo Agents Cada ...
(ATRAVES_DE_POR_VIA)
[locale-violation] ~80-~80: “expertise” é um estrangeirismo. É preferível dizer “especialização”, “perícia”, “experiência”, “domínio” ou “competência”.
Context: ... Conhecimento de domínio - Áreas de expertise Exemplo de system prompt: ``` Você...
(PT_BARBARISMS_REPLACE_EXPERTISE)
[locale-violation] ~143-~143: “Performance” é um estrangeirismo. É preferível dizer “desempenho”, “atuação”, “apresentação”, “espetáculo” ou “interpretação”.
Context: ...s | $$$ | Lento | | Claude 3.5 Sonnet | Performance balanceada, conversas longas | $$ | Ráp...
(PT_BARBARISMS_REPLACE_PERFORMANCE)
[uncategorized] ~237-~237: Esta conjunção deve ser separada por vírgulas e só deve ser utilizada no início duma frase para efeitos de estilo.
Context: ...nter na memória - Janela maior = melhor contexto mas maior custo Controle de Acesso - C...
(VERB_COMMA_CONJUNCTION)
[locale-violation] ~278-~278: “follow-up” é um estrangeirismo. É preferível dizer “continuação” ou “acompanhamento”.
Context: ...ção faltando** - Agent faz perguntas de follow-up 3. Erros - Tools falham, agent lida...
(PT_BARBARISMS_REPLACE_FOLLOW_UP)
[locale-violation] ~288-~288: “performance” é um estrangeirismo. É preferível dizer “desempenho”, “atuação”, “apresentação”, “espetáculo” ou “interpretação”.
Context: ... ## Monitorando Uso do Agent Rastreie performance e uso do agent: - Vá em Uso na sua...
(PT_BARBARISMS_REPLACE_PERFORMANCE)
[grammar] ~298-~298: Possível erro de concordância de número.
Context: ...os de uso inesperados - Melhorar system prompts baseado em padrões reais Lembre-se: Os mel...
(GENERAL_NUMBER_AGREEMENT_ERRORS)
docs/view/src/content/pt-br/full-code-guides/project-structure.mdx
[uncategorized] ~66-~66: Se é uma abreviatura, falta um ponto. Se for uma expressão, coloque entre aspas.
Context: ...fina tool em server/tools/ 2. Execute npm run gen:self para gerar tipos 3. Chame `client...
(ABREVIATIONS_PUNCTUATION)
[locale-violation] ~72-~72: “server” é um estrangeirismo. É preferível dizer “servidor”.
Context: ... sem código de integração. ## Backend (/server) Seu Cloudflare Worker serve: - **`/m...
(PT_BARBARISMS_REPLACE_SERVER)
[uncategorized] ~105-~105: Encontrada possível ausência de vírgula.
Context: ...p. Estenda com campos customizados para API keys, configurações de ambiente, etc. ...
(AI_PT_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~158-~158: Esta é uma palavra só.
Context: ..., }, ]; ### `deco.gen.ts` Tipos auto-gerados. Nunca edite manualmente. bash npm ...
(AUTO)
[misspelling] ~183-~183: Esta é uma palavra só.
Context: ...l` Configuração do Cloudflare Workers. Auto-atualizado ao adicionar integrações. ## Frontend ...
(AUTO)
[locale-violation] ~187-~187: “Router” é um estrangeirismo. É preferível dizer “encaminhador” ou “roteador”.
Context: ...ew`) React 19 + Tailwind v4 + TanStack Router. ``` view/src/ ├── main.tsx # ...
(PT_BARBARISMS_REPLACE_ROUTER)
[misspelling] ~200-~200: Esta é uma palavra só.
Context: ... ### Cliente RPC O cliente rpc.ts é auto-gerado dos seus tools do backend: ```typescri...
(AUTO)
[grammar] ~222-~222: Se ‘inputs’ é um substantivo, ‘todos’ no plural exige um segundo artigo.
Context: ...utocomplete e verificação de tipos para todos inputs/outputs de tools. Veja [Construindo Vi...
(TODOS_FOLLOWED_BY_NOUN_PLURAL)
docs/view/src/content/en/getting-started/context-engineers.mdx
[style] ~84-~84: Consider a more concise word here.
Context: ...obally using npm i -g deco-cli@latest in order to get access to deco commands **2. Singl...
(IN_ORDER_TO_PREMIUM)
docs/view/src/content/pt-br/full-code-guides/building-tools.mdx
[locale-violation] ~177-~177: “server” é um estrangeirismo. É preferível dizer “servidor”.
Context: ...## Registrando Tools Adicione tools em server/main.ts: ```typescript import { withR...
(PT_BARBARISMS_REPLACE_SERVER)
[uncategorized] ~198-~198: Se é uma abreviatura, falta um ponto. Se for uma expressão, coloque entre aspas.
Context: ...lt runtime; ``` Após registro, execute npm run gen:self para gerar tipos para seu fronten...
(ABREVIATIONS_PUNCTUATION)
[misspelling] ~208-~208: Esta é uma palavra só.
Context: ...p`) 4. Teste tools através da interface auto-gerada 2. Via Código: ```typescript // No...
(AUTO)
docs/view/src/content/pt-br/full-code-guides/building-views.mdx
[locale-violation] ~15-~15: “Router” é um estrangeirismo. É preferível dizer “encaminhador” ou “roteador”.
Context: ...d v4** - CSS utility-first - TanStack Router - Roteamento type-safe - Vite - B...
(PT_BARBARISMS_REPLACE_ROUTER)
[misspelling] ~61-~61: Esta é uma palavra só.
Context: ... API** - Chamadas de função diretas - Auto-complete - IDE sugere tools disponíveis Execu...
(AUTO)
[uncategorized] ~63-~63: Se é uma abreviatura, falta um ponto. Se for uma expressão, coloque entre aspas.
Context: ...- IDE sugere tools disponíveis Execute npm run gen:self após adicionar tools para atualiz...
(ABREVIATIONS_PUNCTUATION)
[locale-violation] ~67-~67: “Router” é um estrangeirismo. É preferível dizer “encaminhador” ou “roteador”.
Context: ... tipos. ## Adicionando Rotas TanStack Router provê roteamento type-safe. Para adicio...
(PT_BARBARISMS_REPLACE_ROUTER)
[uncategorized] ~116-~116: Quando não estão acompanhadas de vocativo, as interjeições devem ser finalizadas com pontos de exclamação ou interrogação. Quando houver vocativo, deve usar a vírgula. Para indicar hesitação ou prolongamento de ideias, utilize as reticências.
Context: ...Clique aqui ``` Use src/components/ui/ para componentes reutilizáveis (botões...
(INTERJECTIONS_PUNTUATION)
docs/view/src/content/pt-br/full-code-guides/resources.mdx
[misspelling] ~20-~20: Esta é uma palavra só.
Context: ...fina um schema de resource → Tools CRUD auto-gerados → Cliente frontend type-safe → Atualiza...
(AUTO)
[locale-violation] ~26-~26: “Server” é um estrangeirismo. É preferível dizer “servidor”.
Context: ... via URIs rsc:// - Tempo real com Server-Sent Events --- ## Definir um Resourc...
(PT_BARBARISMS_REPLACE_SERVER)
[locale-violation] ~32-~32: “server” é um estrangeirismo. É preferível dizer “servidor”.
Context: ... Definir um Resource Crie um schema em server/tools/: ```typescript import { Deconf...
(PT_BARBARISMS_REPLACE_SERVER)
[misspelling] ~72-~72: Esta é uma palavra só.
Context: .../resource-id Oresource-id` pode ser auto-gerado ou você pode especificá-lo no CREATE: ...
(AUTO)
[uncategorized] ~83-~83: Se é uma abreviatura, falta um ponto. Se for uma expressão, coloque entre aspas.
Context: ...``` ## Usar no Frontend Após executar npm run gen:self, use o cliente gerado: ### Opera...
(ABREVIATIONS_PUNCTUATION)
[uncategorized] ~307-~307: Encontrada possível ausência de vírgula.
Context: ...ault()` - Valide formatos estritamente (cores hex, emails, URLs) ## Opções Avançadas...
(AI_PT_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~418-~418: Pontuação duplicada
Context: .../ Outros erros } } ``` Erros comuns: - NotFoundError: URI de resource não existe - `Validatio...
(DOUBLE_PUNCTUATION_XML)
[locale-violation] ~423-~423: “Performance” é um estrangeirismo. É preferível dizer “desempenho”, “atuação”, “apresentação”, “espetáculo” ou “interpretação”.
Context: ...m ID já existe (no CREATE) ## Dicas de Performance Paginação: ```typescript // Ruim: ...
(PT_BARBARISMS_REPLACE_PERFORMANCE)
[uncategorized] ~472-~472: Pontuação duplicada
Context: ...n: string, }, }, }) ``` Retorna: - create(env): Função para registrar tools de resource...
(DOUBLE_PUNCTUATION_XML)
docs/view/src/content/pt-br/getting-started/ai-builders.mdx
[locale-violation] ~125-~125: “follow-ups” é um estrangeirismo. É preferível dizer “continuações” ou “acompanhamentos”.
Context: ...recuperação de documentos - Lembretes e follow-ups automatizados ### Processamento de Dad...
(PT_BARBARISMS_REPLACE_FOLLOW_UPS)
[typographical] ~135-~135: Símbolo sem par: “]” aparentemente está ausente
Context: ...er Ajuda: - Acesse nossa comunidade no Discord --...
(UNPAIRED_BRACKETS)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (10)
docs/view/src/utils/navigation.ts (1)
16-49: LGTM! Clean deterministic navigation ordering.The explicit order array and three-tier sorting logic (prioritize ordered items by index → prioritize any ordered item over unordered → alphabetical fallback) is clear and maintainable.
docs/view/src/components/ui/RenderDocument.astro (1)
21-43: LGTM! Proper i18n implementation with appropriate fallbacks.The locale extraction, translation lookup with fallback to
ui.en, and breadcrumb translation logic with capitalized path fallback are well-structured and type-safe.docs/view/src/i18n/ui.ts (1)
11-13: LGTM! Consistent i18n keys across locales.The new sidebar section keys (getting-started, no-code-guides, full-code-guides) are properly defined in both English and Portuguese with appropriate translations.
Also applies to: 25-27
docs/view/src/content/en/getting-started/context-engineers.mdx (1)
1-110: LGTM! Comprehensive and well-structured documentation.The guide provides clear prerequisites, step-by-step setup instructions, and explains the workflow bridging options effectively. The callouts and code examples enhance clarity.
docs/view/src/content/pt-br/full-code-guides/building-tools.mdx (1)
1-278: LGTM! Comprehensive Portuguese documentation with excellent structure.The guide covers all essential aspects: tool anatomy, basic and advanced patterns, integrations, database operations, registration, testing, and best practices. Code examples are clear and practical.
Note: The static analysis hints flagging "server" (line 177), "npm" (line 198), and "auto-gerada" (line 208) are false positives for technical terms and valid Portuguese usage.
docs/view/src/content/en/getting-started/ai-builders.mdx (1)
1-124: LGTM! Excellent beginner-friendly documentation.The step-by-step tutorial progresses naturally from exploring integrations to testing to creating reusable automation. The agent modes section and use case examples provide clear next steps. Callouts enhance understanding without disrupting flow.
docs/view/src/content/pt-br/full-code-guides/building-views.mdx (1)
1-183: LGTM! Comprehensive Portuguese documentation on React views.The guide covers the complete development workflow: stack overview, RPC client usage, routing with TanStack Router, Tailwind styling, and common patterns. Code examples are practical and well-commented.
Note: The static analysis hints flagging "Router" (lines 15, 67), "Auto-complete" (line 61), "npm" (line 63), and punctuation (line 116) are false positives for technical terms and library names that should remain as-is.
docs/view/src/content/en/full-code-guides/building-views.mdx (1)
1-277: Well-structured and comprehensive React documentation.This guide provides clear, actionable guidance on building views with React 19, Tailwind, and the RPC client. Code examples are syntactically correct, explanations are accessible, and the progression from basics (calling tools) through patterns (loading states, error handling) to state management is logical. No technical issues identified.
docs/view/src/content/pt-br/introduction.mdx (2)
3-3: Updated description aligns with restructured documentation scope.Line 3 now emphasizes "Sistema de Gerenciamento de Contexto" (Context Management System), which aligns with the PR's focus on restructuring documentation. The description is accurate and relevant.
131-134: Verify internal navigation links will resolve after i18n/navigation updates.Lines 133–134 reference internal links to
/pt-br/getting-started/ai-buildersand/pt-br/getting-started/context-engineers. Ensure these paths are created or that navigation.ts/ui.ts updates in this PR support these routes. (These are out of scope for this file review but should be verified as part of full PR validation.)
| }); | ||
| ``` | ||
|
|
||
| TypeScript fornece autocomplete e verificação de tipos para todos inputs/outputs de tools. |
There was a problem hiding this comment.
Fix grammar: "todos inputs/outputs" → "todos os inputs/outputs".
Line 222 should include the article "os" for proper Portuguese grammar: "TypeScript fornece autocomplete e verificação de tipos para todos os inputs/outputs de tools."
🧰 Tools
🪛 LanguageTool
[grammar] ~222-~222: Se ‘inputs’ é um substantivo, ‘todos’ no plural exige um segundo artigo.
Context: ...utocomplete e verificação de tipos para todos inputs/outputs de tools. Veja [Construindo Vi...
(TODOS_FOLLOWED_BY_NOUN_PLURAL)
🤖 Prompt for AI Agents
In docs/view/src/content/pt-br/full-code-guides/project-structure.mdx around
line 222, the Portuguese phrase "todos inputs/outputs de tools" is missing the
definite article; update the sentence to read "TypeScript fornece autocomplete e
verificação de tipos para todos os inputs/outputs de tools." to correct the
grammar by inserting "os" before "inputs/outputs".
| - Inclua `name` e `description` para melhor busca | ||
| - Use `.describe()` para documentação | ||
| - Defina padrões sensatos com `.default()` | ||
| - Valide formatos estritamente (cores hex, emails, URLs) |
There was a problem hiding this comment.
Minor: Add missing comma for grammatical clarity.
Line 307: After "(cores hex, emails, URLs)" there should be a comma before "## Opções Avançadas" for better readability: "...URLs),\n\n## Opções Avançadas"
🧰 Tools
🪛 LanguageTool
[uncategorized] ~307-~307: Encontrada possível ausência de vírgula.
Context: ...ault()` - Valide formatos estritamente (cores hex, emails, URLs) ## Opções Avançadas...
(AI_PT_HYDRA_LEO_MISSING_COMMA)
🤖 Prompt for AI Agents
In docs/view/src/content/pt-br/full-code-guides/resources.mdx around line 307,
the sentence ending "(cores hex, emails, URLs)" is missing a trailing comma and
blank line before the "## Opções Avançadas" heading; add a comma after the
closing parenthesis and ensure there is a blank line (i.e., change "...URLs)" to
"...URLs),\n\n") so the punctuation and spacing read: "...URLs),\n\n## Opções
Avançadas".
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/view/src/content/en/no-code-guides/creating-agents.mdx (2)
40-45: Refactor list items for better grammatical consistency.Items 2–4 in the "What happens next" list all begin with verb forms in third-person singular ("Suggests," "Recommends," "Creates"). Consider rewording some items to vary the grammatical structure for better readability.
1. Deco chat asks clarifying questions (What tools? What personality? What boundaries?) -2. Suggests a system prompt based on your needs -3. Recommends which tools to give it -4. Creates the agent using `@AGENTS_CREATE` +2. The system prompt is suggested based on your needs +3. Tool recommendations are made to give it the right capabilities +4. The agent is created using `@AGENTS_CREATE` 5. You test and iterate togetherAlternatively, restructure with active voice from a consistent perspective:
1. Deco chat asks clarifying questions (What tools? What personality? What boundaries?) -2. Suggests a system prompt based on your needs -3. Recommends which tools to give it -4. Creates the agent using `@AGENTS_CREATE` +2. It suggests a system prompt based on your needs +3. It recommends which tools to give it +4. It creates the agent using `@AGENTS_CREATE` 5. You test and iterate together
238-238: Make the tone more formal for consistency with documentation style.Line 238 uses casual phrasing ("you don't need to tell it to, it figures out") which is less formal than the surrounding documentation. Consider tightening the language.
-The agent automatically searches these when relevant. You don't need to tell it to, it figures out when it needs more information. +The agent automatically searches relevant documents when needed and identifies when additional context is required.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/view/src/content/en/no-code-guides/creating-agents.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/view/src/content/en/no-code-guides/creating-agents.mdx
[style] ~41-~41: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...uestions (What tools? What personality? What boundaries?) 2. Suggests a system promp...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~238-~238: Consider using a more formal alternative.
Context: ...ell it to, it figures out when it needs more information. #### Database Context Give agents ac...
(MORE_INFO)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: test
- GitHub Check: Cloudflare Pages
🔇 Additional comments (3)
docs/view/src/content/en/no-code-guides/creating-agents.mdx (3)
1-6: Front matter is well-structured.Title, description, and icon are properly formatted and align with the documentation hierarchy.
264-330: Excellent coverage of advanced settings, testing, and monitoring.The advanced settings section clearly explains each parameter with practical guidance. The testing patterns and monitoring section provides actionable insights for validating and improving agent performance.
1-340: Strong, comprehensive no-code guide for agent creation.This document effectively bridges high-level concepts (via Deco Chat guidance) and deeper mechanics. The progression from "what agents do" to "how to build them" is logical, and the practical examples (system prompts, toolsets, patterns) provide clear, actionable guidance. The document aligns well with the PR's goal to reorganize and enhance documentation with new no-code guides.
…ese documentation - Updated the warning callout in `deployment.mdx` for consistency in verb tense. - Fixed punctuation in the resource validation list in `resources.mdx`. - Adjusted wording in the context engineers guide for clarity in `context-engineers.mdx`.
2 participants
bounties.mdx,getting-started.mdx, andproject-structure.mdx.building-tools.mdx,building-views.mdx,deployment.mdx, andproject-structure.mdxto enhance clarity on tool creation and deployment processes.ui.tsfor improved navigation labels in both English and Portuguese.navigation.tsto ensure consistent ordering of documentation links.What is this contribution about?
Screenshots/Demonstration
Review Checklist
Summary by CodeRabbit
Documentation
Improvements
✏️ Tip: You can customize this high-level summary in your review settings.