Skip to content

Conversation

gabber235
Copy link
Owner

@gabber235 gabber235 commented Jun 9, 2025

Summary

  • keep the confirmation messenger example but remove the unused entry snippet
  • move confirmation entry/messenger into ExampleDialogueEntry.kt
  • highlight the confirmation key handling code
  • update generated snippets

Testing

  • ./extensions/gradlew :_DocsExtension:compileKotlin --console=plain -x test (fails: Directory does not contain a Gradle build)
  • npm ci
  • npm run build (interrupted: build did not finish)

https://chatgpt.com/codex/tasks/task_e_68467d35c7088322a9f3495c12590718

Summary by CodeRabbit

  • Documentation
    • Added a new section explaining the "Confirmation Key" feature for dialogue messengers, including usage instructions and an example.
  • New Features
    • Introduced an example dialogue entry and messenger that pauses until the player presses a configurable confirmation key.
  • Chores
    • Added a code snippet demonstrating how to implement confirmation key handling in a dialogue messenger.

Copy link
Contributor

coderabbitai bot commented Jun 9, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

A new "Confirmation Key" feature for dialogue messengers was documented and exemplified. The documentation now explains how to configure and use a confirmation key, and a code snippet plus implementation for a confirmation dialogue messenger were added. These changes introduce classes and examples to demonstrate awaiting player confirmation before progressing dialogue.

Changes

File(s) Change Summary
documentation/docs/develop/02-extensions/04-entries/trigger/dialogue.mdx Added "Confirmation Key" section explaining configuration and usage, with example and <confirmation_key> tag
documentation/plugins/code-snippets/snippets.json Added code snippet for ExampleConfirmationDialogueMessenger handling confirmation key input
extensions/_DocsExtension/src/.../ExampleDialogueEntry.kt Added ExampleConfirmationDialogueEntry and ExampleConfirmationDialogueMessenger with confirmation logic

Poem

A hop, a skip, a dialogue anew,
Now rabbits wait for your keypress cue!
With snippets and docs, the message is clear—
Press JUMP, SWAP, or SNEAK, your story draws near.
Confirm and continue, the tale hops along—
In the warren of code, you simply belong!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5335cf2 and 006f9b3.

📒 Files selected for processing (1)
  • extensions/_DocsExtension/src/main/kotlin/com/typewritermc/example/entries/trigger/ExampleDialogueEntry.kt (2 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@gabber235 gabber235 merged commit 790e798 into develop Jun 9, 2025
1 of 3 checks passed
@gabber235 gabber235 deleted the codex/add-documentation-for-confirmation-key branch June 9, 2025 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant