Rails 8 Chat App – Part 3: Documentation with AI, Architecture & Testing Guidelines

Welcome to Part 3 of my Rails 8 Chat App series!

In this video, I walk you through the documentation system I built for “Raindy”, a minimalist Rails 8 chat app that combines Tailwind, Turbo Streams, Stimulus, and accessibility-focused UI.

But this isn’t just about markdown and README files — it's about how I design documentation for human developers and AI teammates.

We’ll explore:
- My documentation structure (Architecture and Testing)
- Custom documentation templates for controllers, models, Stimulus, and Turbo
- How I use Mermaid diagrams to visualize app structure
- The role of YAML frontmatter and markdown metadata
- Conventions that help AI generate better code

Whether you're documenting for yourself, a team, or an LLM — I hope this gives you inspiration to structure your own Rails projects.

---
Chapters:
00:00 - Welcome
01:24 - Documentation overview
01:55 - Diagrams
02:48 - Testing overview
04:38 - Architecture overview
05:50 - Stimulus guidelines
07:26 - Turbo guidelines
---

## Related Resources

▶️ Watch Part 1: Raindy Setup & Accessibility UI
https://youtu.be/PBKgxrDKwLc

▶️ Watch Part 2: Testing with Minitest, Capybara, CI
https://youtu.be/Itw5lUlpcJI

▶️ Watch Part 3.1: Lazy AI • Refactored Docs • Final Push
https://youtu.be/IEWrLQ2xttk

▶️ Watch Part 4: Copy to Clipboard with Dispatch and Flash Messages
https://youtu.be/sXoDR-JZTpw

▶️ David Ondrej's Video (I spent 400+ hours in Cursor, here's what I learned)
https://www.youtube.com/watch?v=gYLNxUxVomY

📚 Install Ruby on Rails with mise
- https://guides.rubyonrails.org/install_ruby_on_rails.html

📚 Ravi Kiran Vemula – The Ultimate Guide to AI-Powered Development with Cursor
- https://medium.com/@vrknetha/the-ultimate-guide-to-ai-powered-development-with-cursor-from-chaos-to-clean-code-fc679973bbc4

💻 Raindy GitHub Repo
- https://github.com/aindy-eu/raindy

---

## Credits:
Video von Nans Ceos on Pixabay
https://pixabay.com/de/users/ceos_stock-13890949/
Video von TIME FOR ART on Pixabay
https://pixabay.com/de/users/evgeniy_z-13538513/

---

#Rails8 #Hotwire #StimulusJS #TurboStreams #AIForDevelopers #Minitest #TailwindCSS #ChatApp #DeveloperWorkflow #SoftwareArchitecture

Видео Rails 8 Chat App – Part 3: Documentation with AI, Architecture & Testing Guidelines канала Aindy