Comece aqui
- Começando com Rails
-
Tudo o que você precisa saber para instalar o Rails e criar sua primeira aplicação.
Models
- Active Record Basics
-
Este guia irá ajudá-lo a começar com models, persistência no banco de dados, e no padrão e biblioteca Active Record.
- Active Record Migrations
-
Este guia aborda como você pode usar as migrações do Active Record para alterar seu banco de dados de maneira estruturada e organizada.
- Active Record Validations
-
Este guia aborda como você pode usar as validações do Active Record.
- Active Record Callbacks
-
Este guia aborda como você pode usar as callbacks do Active Record.
- Active Record Associations
-
Este guia abrange todas as associações fornecidas pelo Active Record.
- Active Record Query Interface
-
Este guia abrange a interface de consulta ao banco de dados fornecida pelo Active Record.
- Active Model Basics
-
Este guia aborda o uso de classes model sem o Active Record.
Views
- Action View Overview
- Work in progress
-
Este guia fornece uma introdução ao Action View.
- Layouts and Rendering in Rails
-
Este guia aborda os recursos básicos de layout do Action Controller e do Action View, incluindo renderização e redirecionamento, uso de blocos de content_for e como utilizar partials.
- Action View Helpers
- Work in progress
-
Este guia introduz alguns dos view helpers mais comuns.
- Action View Form Helpers
- Work in progress
-
Guia de uso dos helpers para formulários embutidos no Rails.
Controllers
- Action Controller Overview
- Work in progress
-
Este guia aborda como os controllers funcionam e como eles se encaixam nos ciclos de request da sua aplicação. Inclui sessões, filtros e cookies, transmissão de dados e lidar com exceções levantadas por um request, entre outros tópicos.
- Rails Routing from the Outside In
-
Este guia aborda os recursos voltados ao usuário das rotas do Rails. Se você quiser entender como usar o roteamento em suas aplicações Rails, comece por aqui.
Outros componentes
- Active Support Core Extensions
- Work in progress
-
Este guia documenta as principais extensões do Ruby definidas no Active Support.
- Action Mailer Basics
- Work in progress
-
Este guia aborda como usar o Action Mailer para enviar e receber emails.
- Action Mailbox Basics
- Work in progress
-
Este guia aborda como usar o Action Mailbox para receber emails.
- Action Text Overview
- Work in progress
-
Este guia aborda como usar o Action Rext para com conteúdo de texto com marcações.
- Active Job Basics
- Work in progress
-
Este guia fornece tudo o que você precisa para começar a criar, enfileirar e executar tarefas (jobs) em segundo plano (background).
- Active Storage Overview
- Work in progress
-
Este guia aborda como anexar arquivos aos seus models do Active Record.
- Action Cable Overview
- Work in progress
-
Este guia explica como funciona o Action Cable e como usar WebSockets para criar funcionalidades em tempo real.
Indo mais fundo
- Rails Internationalization (I18n) API
- Work in progress
-
Este guia aborda como adicionar internacionalização para suas aplicações. Sua aplicação poderá traduzir conteúdo para diferentes idiomas, alterar regras de pluralização, usar formatos de data corretos para cada país e assim por diante.
- Testing Rails Applications
- Work in progress
-
Este é um guia é bastante abrangente para as várias facilitades de testar no Rails. Abrange tudo, desde 'O que é um teste?' à teste de integração. Divirta-se.
- Securing Rails Applications
- Work in progress
-
Este guia descreve problemas comuns de segurança em aplicações web e como evitá-los com o Rails.
- Debugging Rails Applications
- Work in progress
-
Este guia descreve como depurar (debug) aplicações Rails. Abrange as diferentes maneiras de realizar e entender o que está acontecendo "nos bastidores" do seu código.
- Configuring Rails Applications
- Work in progress
-
Este guia aborda as configurações básicas de uma aplicação Rails.
- The Rails Command Line
- Work in progress
-
Este guia aborda as ferramentas de linha de comando fornecidas pelo Rails.
- The Asset Pipeline
- Work in progress
-
Este guia documenta a asset pipeline.
- Working with JavaScript in Rails
- Work in progress
-
Este guia aborda as funcionalidades Ajax/JavaScript integradas no Rails.
- The Rails Initialization Process
- Work in progress
-
Este guia explica os aspectos internos do processo de inicialização do Rails.
- Autoloading and Reloading Constants (Zeitwerk Mode)
- Work in progress
-
Este guia documenta como funcionam o carregamento automático e recarregamento de constantes funciona (modo Zeitwerk).
- Autoloading and Reloading Constants (Classic Mode)
- Work in progress
-
Este guia documenta como funcionam o carregamento automático e recarregamento de constantes funciona (modo Clássico).
- Caching with Rails: An Overview
- Work in progress
-
Este guia é uma introdução para acelerar sua aplicação Rails com cache.
- Active Support Instrumentation
- Work in progress
-
Este guia explica como usar a API de instrumentação dentro do Active Support para medir eventos dentro do Rails e outros códigos Ruby.
- Using Rails for API-only Applications
- Work in progress
-
Este guia explica como usar efetivamente o Rails para desenvolver uma API JSON.
- Active Record and PostgreSQL
- Work in progress
-
Este guia aborda o uso específico do Active Record com PostgreSQL.
- Multiple Databases with Active Record
- Work in progress
-
Este guia aborda o uso de múltiplos banco de dados na sua aplicação.
Estendendo o Rails
- The Basics of Creating Rails Plugins
- Work in progress
-
Este guia aborda como construir um plugin para estender as funcionalidades do Rails.
- Rails on Rack
- Work in progress
-
Este guia aborda a integração do Rails com o Rack e as interfaces com outros componentes do Rack.
- Creating and Customizing Rails Generators & Templates
- Work in progress
-
Este guia cobre o processo de adicionar um novo gerador ou fornecer uma alternativa a um elemento de um gerador embutido no Rails (como o fornecimento de stubs alternativos para o gerador scaffold).
- Getting Started with Engines
- Work in progress
-
Este guia explica como escrever uma mountable engine.
- Threading and Code Execution in Rails
- Work in progress
-
Este guia descreve as considerações necessárias e as ferramentas disponíveis ao trabalhar diretamente com a concorrência em uma aplicação Rails.
Contribuições
- Contributing to Ruby on Rails
- Work in progress
-
O Rails não é o framework 'de outras pessoas'. Este guia aborda uma variedade de maneiras que você pode se envolver no desenvolvimento em andamento do Rails.
- API Documentation Guidelines
- Work in progress
-
Este guia documenta as diretrizes de documentação da API do Ruby on Rails.
- Ruby on Rails Guides Guidelines
- Work in progress
-
Este guia documenta as diretrizes dos guias do Ruby on Rails.
Políticas
- Maintenance Policy for Ruby on Rails
- Work in progress
-
Quais versões do Ruby on Rails são suportadas atualmente e quando esperar novas versões.
Release Notes
- Upgrading Ruby on Rails
- Work in progress
-
Este guia ajuda nas atualizações de aplicações para a última versão do Ruby on Rails
- Version 6.1 - Dezembro 2020
- Work in progress
-
Notas de versão para o Rails 6.1.
- Version 6.0 - Agosto 2019
- Work in progress
-
Notas de versão para o Rails 6.0.
- Version 5.2 - April 2018
- Work in progress
-
Notas de versão para o Rails 5.2.
- Version 5.1 - April 2017
- Work in progress
-
Notas de versão para o Rails 5.1.
- Version 5.0 - June 2016
- Work in progress
-
Notas de versão para o Rails 5.0.
- Version 4.2 - December 2014
- Work in progress
-
Notas de versão para o Rails 4.2.
- Version 4.1 - April 2014
- Work in progress
-
Notas de versão para o Rails 4.1.
- Version 4.0 - June 2013
- Work in progress
-
Notas de versão para o Rails 4.0.
- Version 3.2 - January 2012
- Work in progress
-
Notas de versão para o Rails 3.2.
- Version 3.1 - August 2011
- Work in progress
-
Notas de versão para o Rails 3.1.
- Version 3.0 - August 2010
- Work in progress
-
Notas de versão para o Rails 3.0.
- Version 2.3 - March 2009
- Work in progress
-
Notas de versão para o Rails 2.3.
- Version 2.2 - November 2008
- Work in progress
-
Notas de versão para o Rails 2.2.
Feedback
Você é incentivado a ajudar a melhorar a qualidade deste guia.
Por favor, contribua se vir qualquer erros, inclusive erros de digitação. Para começar, você pode ler nossa sessão de contribuindo com a documentação.
Você também pode encontrar conteúdo incompleto ou coisas que não estão atualizadas. Por favor, adicione qualquer documentação em falta na main do Rails. Certifique-se de checar o Edge Guides (en-US) primeiro para verificar se o problema já foi resolvido ou não no branch main. Verifique as Diretrizes do Guia Ruby on Rails para estilo e convenções.
Se, por qualquer motivo, você encontrar algo para consertar, mas não conseguir consertá-lo, por favor abra uma issue no nosso Guia.
E por último, mas não menos importante, qualquer tipo de discussão sobre a documentação do Ruby on Rails é muito bem vinda na lista de discussão rubyonrails-docs e nas issues do Guia em português.