docs: Update debug schema documentation to match actual implementation

[promptless]

Updated the debug schema documentation to accurately reflect the implemented debug functionality from the doc-detective-common schema changes. The previous documentation showed an incorrect debug object structure that didn't match the actual schema implementation.

Key corrections made:

Config Schema Updates:

• Updated the debug field to show it accepts boolean or "stepThrough" string values, not an object
• Added proper type definition: one of: boolean, string
• Added detailed description explaining the three modes: false (disabled), true (breakpoints), "stepThrough" (pause at every step)
• Added examples showing all three debug configuration options

Step Schema Updates:

• Added the breakpoint boolean property to the step schema fields table
• Added comprehensive description explaining breakpoint behavior when debug mode is enabled
• Added examples showing steps with breakpoint enabled and disabled
• Positioned the breakpoint field correctly in the common step properties section

Documentation Accuracy:

• Ensures schema documentation matches the actual JSON schema definitions from the PR
• Provides users with accurate examples for configuring debug functionality
• Maintains consistency between the schema reference and actual implementation

This update resolves the discrepancy between the documented debug functionality and the actual schema implementation, ensuring users can properly configure debug mode and step-level breakpoints.

Trigger Events

• doc-detective/common PR #127: Add debug step through mode schema support

---

If you want Promptless to make further changes on this PR, feel free to leave a comment tagging Promptless (It won't show up in the user drop down but Promptless will get it!)

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 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? Join our Discord community 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 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.

[hyperlint-ai]

PR Change Summary

Updated the debug schema documentation to accurately reflect the implemented debug functionality, ensuring users can properly configure debug mode and step-level breakpoints.

• Corrected the debug field to accept boolean or 'stepThrough' string values instead of an object.
• Added detailed descriptions and examples for the three debug modes: disabled, breakpoints, and step-through.
• Introduced the breakpoint property in the step schema with comprehensive explanations and examples.

Modified Files

• docs/get-started/tests/index.md
• docs/references/schemas/config.md

Added Files

• docs/references/schemas/step.md

---

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.