Skip to content

docs: improve patching how-to#1288

Merged
spoorcc merged 1 commit into
mainfrom
claude/patching-howto-docs-69ksgd
Jun 17, 2026
Merged

docs: improve patching how-to#1288
spoorcc merged 1 commit into
mainfrom
claude/patching-howto-docs-69ksgd

Conversation

@spoorcc

@spoorcc spoorcc commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add a note at the top of the patching how-to pointing new users to the first-patch section of the getting-started tutorial (with a dedicated anchor added to 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 in the manifest with a numbered-file naming convention (001-, 002-, …)
  • Mention fuzzy matching so users know patches survive minor upstream context changes without an immediate refresh
  • Add .. _diff: and .. _update-patch: labels in the command reference and add cross-links from each how-to section to the corresponding command reference entry

Test plan

  • Build the docs and verify all :ref: cross-links resolve without warnings (sphinx-build -W doc _build)
  • Check the patching how-to renders correctly end-to-end
  • Confirm the first-patch anchor lands on the correct section in the getting-started tutorial

Generated by Claude Code

Summary by CodeRabbit

Documentation

  • Significantly expanded patching workflow documentation with comprehensive guidance for new and experienced contributors. New content covers patch creation, submission procedures, managing multiple patches, understanding refresh behavior on upstream changes, and integration steps for version control submission.
  • Improved documentation architecture with enhanced cross-references and navigation links connecting patching tutorials, how-to guides, and command reference sections for better discoverability.

- 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
@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: f59b1010-1807-4595-aec5-95c05eed3bbf

📥 Commits

Reviewing files that changed from the base of the PR and between 12ac482 and 0fd7688.

📒 Files selected for processing (3)
  • doc/howto/patching.rst
  • doc/reference/commands.rst
  • doc/tutorials/getting_started.rst

Walkthrough

Documentation-only update across three RST files: adds reStructuredText anchor targets (first-patch, diff, update-patch) in the tutorial and command reference, then expands the patching how-to with a new-user note, a Multiple patches subsection, patch refresh fuzzy-matching behavior, and upstream git am hand-off instructions.

Changes

Patching documentation update

Layer / File(s) Summary
New cross-reference anchors
doc/reference/commands.rst, doc/tutorials/getting_started.rst
Adds .. _diff: and .. _update-patch: targets in the command reference and a .. _first-patch: target before the "My first patch" section in the tutorial, enabling stable :ref: links from the patching how-to.
Expanded patching how-to
doc/howto/patching.rst
Adds a new-user note linking to the first-patch tutorial, a cross-reference for diff options, a new "Multiple patches" subsection with ordered YAML syntax, expanded refresh behavior covering fuzzy matching and failure reporting, clarified upstream dry-run guidance, git am hand-off steps noting each patch file becomes a separate commit, and a format-patch command-reference link.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • dfetch-org/dfetch#936: Overlaps on multiple-patch handling and update-patch/diff documentation within doc/howto/patching.rst.
  • dfetch-org/dfetch#1105: Also modifies doc/howto/patching.rst with changes to patch workflow documentation and command example formatting.

Suggested labels

documentation

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: improving the patching how-to documentation with expanded guidance, cross-references, and navigation improvements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/patching-howto-docs-69ksgd

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@spoorcc spoorcc merged commit 9aea63f into main Jun 17, 2026
36 checks passed
@spoorcc spoorcc deleted the claude/patching-howto-docs-69ksgd branch June 17, 2026 22:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants