|
| 1 | +# Vendor Documentation |
| 2 | + |
| 3 | +This directory contains local copies of external documentation for quick reference during development. |
| 4 | + |
| 5 | +## Turbo Documentation |
| 6 | + |
| 7 | +### Handbook |
| 8 | +- [Introduction](turbo/handbook/01_introduction.md) |
| 9 | +- [Turbo Drive](turbo/handbook/02_drive.md) |
| 10 | +- [Page Refreshes](turbo/handbook/03_page_refreshes.md) |
| 11 | +- [Turbo Frames](turbo/handbook/04_frames.md) |
| 12 | +- [Turbo Streams](turbo/handbook/05_streams.md) |
| 13 | +- [Turbo Native](turbo/handbook/06_native.md) |
| 14 | +- [Building Your Turbo Application](turbo/handbook/07_building.md) |
| 15 | +- [Installing Turbo](turbo/handbook/08_installing.md) |
| 16 | + |
| 17 | +### Reference |
| 18 | +- [Attributes](turbo/reference/attributes.md) |
| 19 | +- [Drive](turbo/reference/drive.md) |
| 20 | +- [Events](turbo/reference/events.md) |
| 21 | +- [Frames](turbo/reference/frames.md) |
| 22 | +- [Streams](turbo/reference/streams.md) |
| 23 | + |
| 24 | +## Stimulus Documentation |
| 25 | + |
| 26 | +### Handbook |
| 27 | +- [The Origin of Stimulus](stimulus/handbook/00_the_origin_of_stimulus.md) |
| 28 | +- [Introduction](stimulus/handbook/01_introduction.md) |
| 29 | +- [Hello, Stimulus](stimulus/handbook/02_hello_stimulus.md) |
| 30 | +- [Building Something Real](stimulus/handbook/03_building_something_real.md) |
| 31 | +- [Designing for Resilience](stimulus/handbook/04_designing_for_resilience.md) |
| 32 | +- [Managing State](stimulus/handbook/05_managing_state.md) |
| 33 | +- [Working with External Resources](stimulus/handbook/06_working_with_external_resources.md) |
| 34 | +- [Installing Stimulus](stimulus/handbook/07_installing_stimulus.md) |
| 35 | + |
| 36 | +### Reference |
| 37 | +- [Actions](stimulus/reference/actions.md) |
| 38 | +- [Controllers](stimulus/reference/controllers.md) |
| 39 | +- [CSS Classes](stimulus/reference/css_classes.md) |
| 40 | +- [Lifecycle Callbacks](stimulus/reference/lifecycle_callbacks.md) |
| 41 | +- [Outlets](stimulus/reference/outlets.md) |
| 42 | +- [Targets](stimulus/reference/targets.md) |
| 43 | +- [Using TypeScript](stimulus/reference/using_typescript.md) |
| 44 | +- [Values](stimulus/reference/values.md) |
| 45 | + |
| 46 | +## Rails Guides |
| 47 | + |
| 48 | +### Getting Started |
| 49 | +- [Getting Started with Rails](rails/guides/getting_started.md) |
| 50 | +- [Installing Ruby on Rails](rails/guides/install_ruby_on_rails.md) |
| 51 | +- [Getting Started with Dev Container](rails/guides/getting_started_with_devcontainer.md) |
| 52 | + |
| 53 | +### Models |
| 54 | +- [Active Record Basics](rails/guides/active_record_basics.md) |
| 55 | +- [Active Record Migrations](rails/guides/active_record_migrations.md) |
| 56 | +- [Active Record Validations](rails/guides/active_record_validations.md) |
| 57 | +- [Active Record Callbacks](rails/guides/active_record_callbacks.md) |
| 58 | +- [Active Record Associations](rails/guides/association_basics.md) |
| 59 | +- [Active Record Query Interface](rails/guides/active_record_querying.md) |
| 60 | +- [Active Model Basics](rails/guides/active_model_basics.md) |
| 61 | +- [Active Record Encryption](rails/guides/active_record_encryption.md) |
| 62 | +- [Active Record and PostgreSQL](rails/guides/active_record_postgresql.md) |
| 63 | +- [Multiple Databases](rails/guides/active_record_multiple_databases.md) |
| 64 | +- [Composite Primary Keys](rails/guides/active_record_composite_primary_keys.md) |
| 65 | + |
| 66 | +### Views |
| 67 | +- [Action View Overview](rails/guides/action_view_overview.md) |
| 68 | +- [Layouts and Rendering](rails/guides/layouts_and_rendering.md) |
| 69 | +- [Action View Helpers](rails/guides/action_view_helpers.md) |
| 70 | +- [Form Helpers](rails/guides/form_helpers.md) |
| 71 | + |
| 72 | +### Controllers |
| 73 | +- [Action Controller Overview](rails/guides/action_controller_overview.md) |
| 74 | +- [Rails Routing](rails/guides/routing.md) |
| 75 | +- [Action Controller Advanced Topics](rails/guides/action_controller_advanced_topics.md) |
| 76 | + |
| 77 | +### Other Components |
| 78 | +- [Active Job Basics](rails/guides/active_job_basics.md) |
| 79 | +- [Action Mailer Basics](rails/guides/action_mailer_basics.md) |
| 80 | +- [Action Cable Overview](rails/guides/action_cable_overview.md) |
| 81 | +- [Active Storage Overview](rails/guides/active_storage_overview.md) |
| 82 | +- [Action Text Overview](rails/guides/action_text_overview.md) |
| 83 | +- [Action Mailbox Basics](rails/guides/action_mailbox_basics.md) |
| 84 | + |
| 85 | +### Digging Deeper |
| 86 | +- [Rails Internationalization (I18n)](rails/guides/i18n.md) |
| 87 | +- [Testing Rails Applications](rails/guides/testing.md) |
| 88 | +- [Securing Rails Applications](rails/guides/security.md) |
| 89 | +- [Debugging Rails Applications](rails/guides/debugging_rails_applications.md) |
| 90 | +- [Configuration](rails/guides/configuring.md) |
| 91 | +- [Command Line Tools](rails/guides/command_line.md) |
| 92 | +- [Asset Pipeline](rails/guides/asset_pipeline.md) |
| 93 | +- [Working with JavaScript](rails/guides/working_with_javascript_in_rails.md) |
| 94 | +- [Initialization Process](rails/guides/initialization.md) |
| 95 | +- [Autoloading and Reloading](rails/guides/autoloading_and_reloading_constants.md) |
| 96 | +- [Caching with Rails](rails/guides/caching_with_rails.md) |
| 97 | +- [Active Support Instrumentation](rails/guides/active_support_instrumentation.md) |
| 98 | +- [Error Reporting](rails/guides/error_reporting.md) |
| 99 | +- [Threading and Code Execution](rails/guides/threading_and_code_execution.md) |
| 100 | + |
| 101 | +### Extending Rails |
| 102 | +- [Creating Rails Plugins](rails/guides/plugins.md) |
| 103 | +- [Rails on Rack](rails/guides/rails_on_rack.md) |
| 104 | +- [Creating Rails Generators](rails/guides/generators.md) |
| 105 | +- [Getting Started with Engines](rails/guides/engines.md) |
| 106 | +- [API-only Applications](rails/guides/api_app.md) |
| 107 | +- [Active Support Core Extensions](rails/guides/active_support_core_extensions.md) |
| 108 | + |
| 109 | +### Contributing |
| 110 | +- [Contributing to Ruby on Rails](rails/guides/contributing_to_ruby_on_rails.md) |
| 111 | +- [API Documentation Guidelines](rails/guides/api_documentation_guidelines.md) |
| 112 | +- [Ruby on Rails Guides Guidelines](rails/guides/ruby_on_rails_guides_guidelines.md) |
| 113 | +- [Development Dependencies Install](rails/guides/development_dependencies_install.md) |
| 114 | + |
| 115 | +### Maintenance |
| 116 | +- [Maintenance Policy](rails/guides/maintenance_policy.md) |
| 117 | +- [Upgrading Ruby on Rails](rails/guides/upgrading_ruby_on_rails.md) |
| 118 | +- [Tuning Performance for Deployment](rails/guides/tuning_performance_for_deployment.md) |
| 119 | + |
| 120 | +### Release Notes |
| 121 | +- [Rails 8.1](rails/guides/8_1_release_notes.md) |
| 122 | +- [Rails 8.0](rails/guides/8_0_release_notes.md) |
| 123 | +- [Rails 7.2](rails/guides/7_2_release_notes.md) |
| 124 | +- [Rails 7.1](rails/guides/7_1_release_notes.md) |
| 125 | +- [Rails 7.0](rails/guides/7_0_release_notes.md) |
| 126 | +- [Rails 6.1](rails/guides/6_1_release_notes.md) |
| 127 | +- [Rails 6.0](rails/guides/6_0_release_notes.md) |
| 128 | +- [Rails 5.2](rails/guides/5_2_release_notes.md) |
| 129 | +- [Rails 5.1](rails/guides/5_1_release_notes.md) |
| 130 | +- [Rails 5.0](rails/guides/5_0_release_notes.md) |
| 131 | +- (and earlier versions...) |
| 132 | + |
| 133 | +## Sources |
| 134 | + |
| 135 | +- Turbo documentation from: https://github.com/hotwired/turbo-site |
| 136 | +- Stimulus documentation from: https://github.com/hotwired/stimulus |
| 137 | +- Rails Guides from: https://github.com/rails/rails/tree/main/guides/source |
| 138 | + |
| 139 | +Last updated: June 25, 2025 |
0 commit comments