Skip to content

Expand cursor documentation#483

Merged
timtebeek merged 1 commit intomasterfrom
tim/cursor-methods-docs
Apr 9, 2026
Merged

Expand cursor documentation#483
timtebeek merged 1 commit intomasterfrom
tim/cursor-methods-docs

Conversation

@timtebeek
Copy link
Copy Markdown
Member

@timtebeek timtebeek commented Apr 9, 2026

Summary

  • Addresses Expand cursor documentation #264. Adds a new dedicated Cursors page under Concepts & Explanations covering the full Cursor API with practical code examples drawn from real recipe modules.

  • New page (docs/concepts-and-explanations/cursors.md): covers parent navigation (getParent vs getParentTreeCursor), ancestor search (firstEnclosing, dropParentUntil/While), cursor messaging (putMessage/getMessage/pollMessage and variants), updateCursor(), new Cursor() construction, and common patterns.

  • Trimmed the existing Cursoring section in visitors.md to a brief summary with a cross-link to the new page.

  • Updated sidebar and cross-references in modifying-methods-with-javatemplate.md.

Test plan

  • npm run build succeeds with no broken links
  • Review rendered page for clarity and accuracy

Addresses #264. Creates a new Cursors page in
concepts-and-explanations covering the full Cursor API: parent navigation,
ancestor search, cursor messaging, updateCursor, new Cursor construction,
and common patterns with code examples. Trims the existing Cursoring
section in visitors.md to a summary with cross-link.
@github-project-automation github-project-automation bot moved this to In Progress in OpenRewrite Apr 9, 2026
@timtebeek timtebeek added the documentation Improvements or additions to documentation label Apr 9, 2026
@timtebeek timtebeek linked an issue Apr 9, 2026 that may be closed by this pull request
@timtebeek timtebeek marked this pull request as ready for review April 9, 2026 20:59
@github-project-automation github-project-automation bot moved this from In Progress to Ready to Review in OpenRewrite Apr 9, 2026
@timtebeek timtebeek merged commit 90819b0 into master Apr 9, 2026
2 checks passed
@timtebeek timtebeek deleted the tim/cursor-methods-docs branch April 9, 2026 21:18
@github-project-automation github-project-automation bot moved this from Ready to Review to Done in OpenRewrite Apr 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Expand cursor documentation

2 participants