QUIC Test Documentation
This directory contains comprehensive documentation for the QUIC Test application and its associated tools.
Available Documentation
TUI User Guide
File: TUI_USER_GUIDE.md
Complete guide to using the QUIC Bottom Real Terminal User Interface (TUI) application. Includes:
- Installation and setup instructions
- Detailed description of all view modes
- Keyboard shortcuts reference
- Metrics interpretation guide
- Troubleshooting section
- Best practices
Target Audience: Users who need to interact with the TUI application for monitoring and analyzing QUIC protocol metrics.
Quick Start Guides
For quick reference on specific topics, see the main project directory:
BBRv3_DEMO_QUICK_START.md: Quick start for BBRv3 demonstrationsBBRv3_IMPLEMENTATION_TASK.md: Technical implementation details
Lecture Materials
For educational materials and lecture guides, see:
MEI_LECTURE/: Directory containing lecture materials, demo guides, and presentation outlines
Documentation Structure
docs/
+-- README.md # This file
+-- TUI_USER_GUIDE.md # Complete TUI usage guide
+-- media/ # Media files
+-- quic-thumbnail.jpg # Video thumbnail/preview
Contributing
When adding new documentation:
- Use Markdown format
- Follow the existing documentation style
- Include table of contents for documents longer than 50 lines
- Provide code examples where applicable
- Include troubleshooting sections for complex topics
Updates
Documentation is updated as new features are added to the application. Check the version information in each document to ensure compatibility with your installed version.