Skip to content

Commit b3493ca

Browse files
committed
Update IA redesign plan to reflect Phase 3 completion
Mark Phase 3 as completed with notes on what actually happened vs what was planned: - ✅ Created introduction.md (as planned) - ✅ Transformed getting-started.md → using-react-on-rails.md (adapted from original plan) - ✅ Simplified README.md (kept, not deleted) - ✅ Deleted home.md (as planned) - ✅ Added tutorial improvements (discovered during work) - ✅ Deleted manual-installation-overview.md (discovered during work) - ✅ Updated cross-references manually (not scripted) Updated testing checklist to show what's complete and what's deferred to Phase 1.
1 parent 487fb13 commit b3493ca

File tree

1 file changed

+42
-33
lines changed

1 file changed

+42
-33
lines changed

docs/planning/docs-improvement/04-ia-redesign-plan.md

Lines changed: 42 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -796,59 +796,68 @@ echo "✅ Files reorganized. Review changes before committing."
796796

797797
### Phase 3: Content Updates (react_on_rails repo)
798798

799+
**STATUS:** ✅ COMPLETED (with adaptations) - See ia-redesign-live.md for details
800+
799801
**Create new files:**
800802

801-
**1. `docs/introduction.md`**
803+
**1. `docs/introduction.md`** ✅ DONE
802804

803805
- Homepage for docs
804806
- Explains what React on Rails is
805807
- Why use it vs alternatives
806808
- Links to three paths (Quick Start, Installation, Tutorial)
807809
- Philosophy section
808810

809-
**2. Split `docs/getting-started.md`:**
811+
**2. Split `docs/getting-started.md`:** ✅ DONE (but transformed, not split)
812+
813+
- **PLANNED:** Move installation → `docs/getting-started/installation.md`
814+
- **ACTUAL:** Transformed to `docs/getting-started/using-react-on-rails.md` (conceptual guide)
815+
- **REASON:** installation.md already existed, needed conceptual guide instead
816+
- DELETE original after content extracted ✅ DONE
810817

811-
- Move installation → `docs/getting-started/installation.md`
812-
- Move concepts → Core Concepts category
813-
- Move API examples → API Reference
814-
- DELETE original after content extracted
818+
**3. Update `docs/README.md`:** ✅ DONE (kept simplified)
815819

816-
**3. Update `docs/README.md`:**
817-
Option A: Delete entirely (introduction.md is new homepage)
818-
Option B: Keep as simple TOC without learning paths
820+
- **DECIDED:** Option B (kept as simple TOC)
821+
- Reduced from 173 → 65 lines
822+
- Serves GitHub users browsing repo
819823

820-
**4. Delete `docs/home.md`:**
824+
**4. Delete `docs/home.md`:** ✅ DONE
821825

822826
- Redundant with introduction.md
823827

824-
**5. Update cross-references:**
828+
**ADDITIONS (discovered during implementation):**
825829

826-
- Search all docs for links to moved files
827-
- Update relative paths
828-
- Automated script:
830+
**5. Tutorial improvements** ✅ DONE
829831

830-
```bash
831-
#!/bin/bash
832-
# Update internal links after reorganization
833-
834-
# Find all .md files
835-
find docs -name "*.md" -type f | while read file; do
836-
# Replace old paths with new paths
837-
sed -i 's|guides/installation-into-an-existing-rails-app.md|getting-started/installation.md|g' "$file"
838-
sed -i 's|guides/tutorial.md|getting-started/tutorial.md|g' "$file"
839-
sed -i 's|guides/how-react-on-rails-works.md|core-concepts/how-it-works.md|g' "$file"
840-
# ... etc for all moved files
841-
done
842-
```
832+
- Extracted Heroku deployment (139 lines) to dedicated guide
833+
- Fixed outdated versions (Ruby 3.0+, Rails 7+, RoR v16)
834+
- Clarified Redux vs Hooks usage
835+
- Merged duplicate HMR sections
836+
- Reorganized "Other features" → "Going Further"
837+
838+
**6. Delete `manual-installation-overview.md`** ✅ DONE
839+
840+
- Outdated since 2018
841+
- Confused purpose
842+
- No clear use case (generator IS manual installation)
843+
844+
**7. Update cross-references:** ✅ DONE (manually)
845+
846+
- Updated links to renamed/moved files as they were discovered
847+
- Key changes:
848+
- overview.md → introduction.md (2 links)
849+
- understanding-react-on-rails.md → using-react-on-rails.md (1 link)
850+
- manual-installation-overview.md link removed (1 link)
851+
- **NOTE:** Did not use automated script - manual updates were more appropriate given incremental changes
843852

844853
**Testing checklist:**
845854

846-
- [ ] All new files created
847-
- [ ] Old files deleted or split
848-
- [ ] All internal links updated
849-
- [ ] Run markdown link checker
850-
- [ ] Manual spot-checks of navigation
851-
- [ ] Test on local gatsby build
855+
- [x] All new files created
856+
- [x] Old files deleted or transformed
857+
- [x] All internal links updated (manually as encountered)
858+
- [ ] Run markdown link checker (TODO: before final merge)
859+
- [x] Manual spot-checks of navigation
860+
- [ ] Test on local gatsby build (deferred to Phase 1 - website config)
852861

853862
---
854863

0 commit comments

Comments
 (0)