documentation

VeriStruct Documentation

This directory contains comprehensive documentation for the VeriStruct system.

Directory Structure

/technical

Contains technical documentation about system components and architecture:

• modules: Module-level documentation for individual VeriStruct components
• planner.md: In-depth documentation of the planning system
• workflow.md: Detailed explanation of the VeriStruct workflow

/tutorial

Step-by-step guides for using VeriStruct:

• 01_getting_started.md: Initial setup and first verification
• 02_basic_verification.md: Simple verification tasks
• 03_advanced_verification.md: Complex verification scenarios
• 04_troubleshooting.md: Solutions for common issues

Documentation Guidelines

1. File Organization:

   • Use meaningful file names
   • Group related documents in subdirectories
   • Keep a flat hierarchy where possible

2. Content Structure:

   • Start with a clear overview
   • Use consistent headers
   • Include diagrams where helpful
   • Provide code examples

3. Markdown Formatting:

   • Use proper Markdown syntax
   • Include code blocks with language tags
   • Use tables for structured data
   • Include diagrams using Mermaid

4. Updates:

   • Keep documentation in sync with code
   • Update examples when APIs change
   • Maintain version compatibility notes
   • Document breaking changes