Vxplain leverages Markdown to present the information it generates in a clear and readable format. When you generate summaries or other text-based outputs, they will be rendered as Markdown.

Code Summaries

When you right-click on a specific function, Vxplain gives you the option to generate a summary. This provides a concise explanation of the code’s purpose and functionality in Markdown, including code blocks for any relevant snippets. This allows you to easily copy and paste the summaries into your own documentation files or share them with your team.

Architecture Summaries

In the architecture diagrams page, you can find an option to generate an ‘Architecture overview’. This provides a high-level summary of your entire codebase, explaining the main components and their interactions.