Skip to content

Commit e60ff6b

Browse files
committed
Update ia-redesign-live.md with Decision 4 & 5 (corrected)
Decision 4: Rethink Deployment Category - Analyzed files that ended up in deployment/ - Found 5 files that don't belong (not deployment-specific) - Moved to better categories keeping original filenames - Pattern: Categorize by WHEN and WHY users need info Decision 5: No "Rails" Category Needed - Considered creating Rails category for Rails-specific files - Decided against it - would become dumping ground - React on Rails IS Rails integration - everything is Rails-related - Pattern: Intent-based beats technology-based categorization All filenames kept original per Decision 2 (no renaming). Updated folder structure reference to reflect actual filenames.
1 parent b5f3be5 commit e60ff6b

File tree

1 file changed

+78
-14
lines changed

1 file changed

+78
-14
lines changed

docs/planning/docs-improvement/ia-redesign-live.md

Lines changed: 78 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,56 @@ This section tracks any deviations from the original plan and why we made them.
201201

202202
---
203203

204+
#### Decision 4: Rethink Deployment Category - Remove Non-Deployment Files (Oct 3, 2025)
205+
206+
**Context:** After completing Step 5 (moving Deployment files), we reviewed what actually ended up in `deployment/` and found several files that don't belong.
207+
208+
**Problem:** The plan placed these files in Deployment, but upon review they're not deployment-specific.
209+
210+
**Decision:** Move these 5 files OUT of Deployment to proper categories (keeping original filenames per Decision 2):
211+
212+
1. `updating-dependencies.md`**misc/updating-dependencies.md** (temporary holding)
213+
2. `turbolinks.md`**building-features/turbolinks.md** (feature integration)
214+
3. `rails-engine-integration.md`**advanced-topics/rails-engine-integration.md** (temporary holding)
215+
4. `convert-rails-5-api-only-app.md`**migrating/convert-rails-5-api-only-app.md** (prerequisite migration)
216+
5. `rails_view_rendering_from_inline_javascript.md`**api-reference/rails_view_rendering_from_inline_javascript.md** (API reference)
217+
218+
**New temporary categories created:**
219+
- `misc/` - For files that don't fit elsewhere (review at end)
220+
- `advanced-topics/` - For advanced setup scenarios (review at end)
221+
222+
**Deployment category now contains (7 files):**
223+
- Production deployment guides (4 files: deployment.md, capistrano, heroku, elastic-beanstalk)
224+
- Troubleshooting production/CI issues (3 files)
225+
226+
**Rationale:**
227+
- Don't force-fit files to match the plan if they don't belong
228+
- Follow industry standards: categorize by user intent, not by technology
229+
- Protect important categories from bloat
230+
- Gather orphaned files in temporary categories for later review
231+
- Deployment should be about getting to production and operating in production
232+
233+
**Pattern:** Categorize by WHEN and WHY users need the info, not by what technology it involves.
234+
235+
---
236+
237+
#### Decision 5: No "Rails" Category Needed (Oct 3, 2025)
238+
239+
**Question:** Should we create a "Rails" category for Rails-specific files?
240+
241+
**Decision:** NO - do not create a "Rails" category.
242+
243+
**Rationale:**
244+
- React on Rails IS a Rails integration - everything is Rails-related
245+
- A "Rails" category would become a dumping ground like the old "Additional details"
246+
- Better to categorize by user intent (what are they trying to do?) not by technology
247+
- Industry pattern: Stimulus, Turbo, Inertia.js don't have "Rails" categories
248+
- Files from old `rails/` folder distributed to appropriate categories by intent
249+
250+
**Pattern:** Intent-based categorization (user journey) beats technology-based categorization.
251+
252+
---
253+
204254
## Issues & Blockers
205255

206256
### Issue 1: Content Overlap in Getting Started (Oct 2, 2025)
@@ -257,39 +307,53 @@ _Test results will be logged here as we go_
257307

258308
```
259309
docs/
260-
├── introduction.md # NEW HOMEPAGE (to be created)
310+
├── introduction.md # NEW HOMEPAGE (to be created in Step 8)
261311
├── getting-started/
262312
│ ├── quick-start.md
263313
│ ├── installation-into-an-existing-rails-app.md # Decision 2: keep long name
264314
│ ├── tutorial.md
265315
│ └── project-structure.md
266316
├── core-concepts/
267-
│ ├── server-side-rendering.md
268-
│ ├── client-vs-server-rendering.md
317+
│ ├── how-react-on-rails-works.md
318+
│ ├── react-on-rails-overview.md
269319
│ └── ...
270320
├── building-features/
271-
│ ├── using-redux.md
272321
│ ├── react-router.md
322+
│ ├── react-and-redux.md
323+
│ ├── turbolinks.md # Decision 4: moved from deployment
273324
│ └── ...
274325
├── api-reference/
275326
│ ├── view-helpers-api.md
276-
│ ├── configuration.md
327+
│ ├── javascript-api.md
328+
│ ├── configuration.md # Decision 3: reference list
329+
│ ├── rails_view_rendering_from_inline_javascript.md # Decision 4: moved from rails/
277330
│ └── ...
278331
├── deployment/
279-
│ ├── production-deployment.md
280-
│ ├── troubleshooting.md
281-
│ └── ...
282-
├── upgrading/ # SPLIT from migration (Decision 1)
332+
│ ├── deployment.md # Decision 4: focused on production only
333+
│ ├── capistrano-deployment.md
334+
│ ├── heroku-deployment.md
335+
│ ├── elastic-beanstalk.md
336+
│ ├── troubleshooting-build-errors.md
337+
│ ├── troubleshooting-when-using-shakapacker.md
338+
│ └── troubleshooting-when-using-webpacker.md
339+
├── upgrading/ # Decision 1: SPLIT from migration
283340
│ ├── upgrading-react-on-rails.md
284341
│ ├── release-notes/
285342
│ └── ...
286-
├── migrating/ # SPLIT from migration (Decision 1)
343+
├── migrating/ # Decision 1: SPLIT from migration
287344
│ ├── from-react-rails.md
288345
│ ├── from-angular.md
346+
│ ├── convert-rails-5-api-only-app.md # Decision 4: moved from deployment
289347
│ └── ...
290-
└── pro/
291-
├── react-on-rails-pro.md
292-
└── ...
348+
├── pro/
349+
│ ├── react-on-rails-pro.md
350+
│ └── ...
351+
├── misc/ # Decision 4: TEMPORARY - review later
352+
│ └── updating-dependencies.md
353+
└── advanced-topics/ # Decision 4: TEMPORARY - review later
354+
└── rails-engine-integration.md
293355
```
294356

295-
See `04-ia-redesign-plan.md` for detailed file mapping (NOTE: plan has old structure, use this as reference).
357+
**Note:** `misc/` and `advanced-topics/` are temporary holding folders created in Decision 4. We'll review at the end whether to keep these categories or redistribute files. All filenames kept original per Decision 2.
358+
359+
See `04-ia-redesign-plan.md` for detailed file mapping (NOTE: plan has old structure, use this live doc as source of truth).

0 commit comments

Comments
 (0)