docs: improve patching how-to#1288
Conversation
- Add a note at the top pointing new users to the first-patch tutorial (with a dedicated anchor on that section) - Expand the upstream section: dry-run check first, then git am with a link to the official git-am docs; note that each patch yields a separate commit; keep git-specific instructions inside the Git tab - Document multiple patch support with a numbered-file naming convention - Mention fuzzy matching so users know patches survive minor upstream context changes - Add ref labels for diff and update-patch in the command reference and link each how-to section to the corresponding command reference entry Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HSFnUY2fa6WxQ7SwJ94H3Y
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (3)
WalkthroughDocumentation-only update across three RST files: adds reStructuredText anchor targets ( ChangesPatching documentation update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
first-patchsection of the getting-started tutorial (with a dedicated anchor added to that section)git amwith a link to the official git-am docs; note that each patch yields a separate commit; keep git-specific instructions inside the Git tab001-,002-, …).. _diff:and.. _update-patch:labels in the command reference and add cross-links from each how-to section to the corresponding command reference entryTest plan
:ref:cross-links resolve without warnings (sphinx-build -W doc _build)first-patchanchor lands on the correct section in the getting-started tutorialGenerated by Claude Code
Summary by CodeRabbit
Documentation