Commands
Navigate from an insight or a failed check to actionable comments or suggestions
Last updated
Navigate from an insight or a failed check to actionable comments or suggestions
Last updated
Topic Commands allow users to quickly navigate from an insight or a failed check to actionable comments or suggestions on the relevant lines of code. These commands help users take immediate action based on insights and errors, making it clear what needs to be done to resolve issues.
How It Works
Add a Comment: This command starts a comment on the exact line(s) where the issue or insight is relevant. The comment automatically includes the Summary of the insight, which is generated by AI to concisely explain the issue.
Go to File: This command directs the user to the precise line location in the file where the issue or insight occurred. It highlights the code lines, making it easier for the user to review and act on them.
Code and Log Previews
Code Preview: When using Topic Commands, a preview of the affected code is shown, displaying the line of code with +/- 1 line from the first line in the range.
Log Preview: The logs related to the issue are also shown. The preview includes +/- 1 line from the last log trace for the relevant entry point.
Check Preview: For failed checks, the preview displays the lines +/- 1 line from the last log related to the failure.
Insight Summary
Each Topic Command comes with a Summary, which provides key information based on the insight or failure. These summaries are AI-generated and offer concise details on:
Breaking Changes: A short description of the changes required, covering fields that have been removed or modified, and the potential impact on the rest of the system.
Required Changes: Action items for the user to implement to resolve or mitigate the issue.
Potential Impact: A summary of how the changes might affect other parts of the code or system.
Checks and Error Analysis
For failed checks, Topic Commands also include an analysis of the failure:
Root Cause: A detailed explanation of what caused the failure, which might include error messages, suspected causes (like race conditions, database issues), and common resolutions.
Steps to Resolve: Recommendations on how to fix the issue, based on the analysis provided by Baz's AI system.
