WRProfiler.Cli 1.0.1

WRProfiler Documentation Package

Overview

This directory contains comprehensive documentation for WRProfiler, an enterprise-grade observability and performance profiling library for .NET applications. The documentation is organized into two main categories for different audiences and use cases.

Documentation Structure

Public Usage Documentation

• File: PublicUsageGuide.md
• Audience: External developers, open-source users, and general .NET community
• Purpose: Comprehensive guide for implementing and using WRProfiler in any .NET application
• Content: Installation, configuration, feature guides, API references, and troubleshooting

Quick Access

For General Usage

1. Start with Public Usage Guide for basic setup
2. Refer to configuration sections for your specific database provider
3. Use the CLI tools for analysis and maintenance

Documentation Features

Cross-References

Both documents include:

• Internal links between related sections
• Code examples with complete, copy-pasteable implementations
• Configuration reference tables with defaults and descriptions
• Troubleshooting guides for common issues

Version Compatibility

• Clear version compatibility matrices
• Migration guidance between versions
• Backward compatibility notes

Best Practices

• Performance optimization recommendations
• Security considerations
• Production deployment guidelines
• Development vs production configuration differences

Additional Resources

Source Code Reference

For detailed implementation reference, explore the source code in:

• src/core/WRProfiler/ - Core library implementation
• src/tools/WRProfiler.Cli/ - Command-line interface
• src/test/WRProfiler.Tests/ - Test suite and examples

Database Schema

Refer to the documentation for complete database schema details including:

• Table structures and relationships
• Indexing recommendations
• Data retention policies
• Performance considerations

Support and Contribution

Getting Help

• Check the troubleshooting sections in both guides
• Review common issues and solutions
• Examine the code examples for implementation patterns

Contributing Documentation

When updating or extending documentation:

1. Maintain consistent formatting and structure
2. Include complete code examples
3. Update version compatibility information
4. Cross-reference related sections
5. Test all code examples for accuracy

Feedback and Improvements

Documentation improvements are welcome through:

• GitHub issues for documentation bugs
• Pull requests for content updates
• Feature requests for additional documentation needs

License

This documentation is provided under the same license as WRProfiler. See the main project LICENSE file for details.