Skip to content

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Jun 25, 2025

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


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
Copy link
Contributor

coderabbitai bot commented Jun 25, 2025

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.


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

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Jun 25, 2025

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.

@promptless
Copy link
Contributor Author

promptless bot commented Oct 11, 2025

I've added the requested changes in commit 9a1c012

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.

1 participant