docs: normalize Rails 7 migration pattern docs (WA-DOC-018)#1125
Open
kitcommerce wants to merge 1 commit intonextfrom
Open
docs: normalize Rails 7 migration pattern docs (WA-DOC-018)#1125kitcommerce wants to merge 1 commit intonextfrom
kitcommerce wants to merge 1 commit intonextfrom
Conversation
…e (WA-DOC-018) - Ensure all 11 pattern docs have: Symptom, Root cause, Detection, Fix, and References/Links sections - Normalize heading casing (e.g. 'Root Cause' → 'Root cause', 'See Also' → 'References') - Rename section aliases to canonical names: - 'Workarea PR (or Issue)' → 'References / Links' - 'See Also' → 'References' - 'Migration Steps' → 'Fix' - Add missing Symptom/Root cause/Detection/Fix/References sections to: - webpacker-to-sprockets-4.md - jsbundling-rails-esbuild.md - deprecation-sweep-results.md - error-reporting.md - load-defaults-7-2.md - rails-7-2-notes.md - zeitwerk-notes.md - Replace hardcoded local paths with generic placeholders (none found) - Update README.md with full index table linking all pattern docs with one-line descriptions Closes #909 (WA-DOC-018)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Normalizes all docs in
docs/rails7-migration-patterns/to a consistent five-section structure and updates the README index.Closes #909 (WA-DOC-018)
Changes
Section normalization (all 11 pattern docs)
Each pattern doc now has these canonical
##sections in order:Heading renames
Root Cause→Root cause(assets-pipeline, bigdecimal, sprockets-manifest)See Also→References(assets-pipeline)Workarea PR (or Issue)→References / Links(url-routing-helpers)Workarea PR / Issue→References(middleware-stack-ordering, sprockets-manifest)Migration Steps→Fix(webpacker-to-sprockets-4)New sections added
Docs that were status reports / audit notes rather than structured patterns received
the full Symptom/Root cause/Detection/Fix preamble:
webpacker-to-sprockets-4.mdjsbundling-rails-esbuild.mddeprecation-sweep-results.mderror-reporting.mdload-defaults-7-2.mdrails-7-2-notes.mdzeitwerk-notes.mdREADME index
Replaced the partial bullet list with a full Markdown table linking all 11 pattern docs
with one-line descriptions.
Client impact
None — documentation changes only.
Verification Plan
Confirm each of the 11 pattern docs has all five required
##sections:Expected: each non-README file prints all five sections.
Confirm README links resolve — all filenames in the table exist:
Confirm no hardcoded local paths remain:
grep -rn 'Users/Shared/openclaw' docs/rails7-migration-patterns/Expected: no output.