kbe
6300bebe33
- Example5: Fix format string bugs (alignment specifier placement, SafeMemoryHandle formatting) - Example4: Fix DetourManager.Detour() → Create() in all doc strings - Example3: Fix MemoryBase.CreateFunction() → InProcessInvoker.CreateFunction() in doc strings - Examples 1-5: Correct all runtime errors and API mismatches vs actual WhiteMagic API - README: Fix DetourManager.Detour() examples to use Create(); add missing code fence markers - Add WhiteMagic.Examples project with 5 comprehensive example files (40+ sub-examples) - Add docfx.json and toc.md for DocFX API reference generation - Add 5 conceptual guides: architecture, memory-access, execution-models, hooking, troubleshooting - Ensure zero errors, zero warnings across all projects (net8.0-windows) Doc strings now teach correct APIs; runtime format bugs eliminated; build succeeds.
31 lines
1.0 KiB
Markdown
31 lines
1.0 KiB
Markdown
# WhiteMagic Documentation
|
|
|
|
## [Home](index.md)
|
|
|
|
## Getting Started
|
|
- [Installation](docs/installation.md)
|
|
- [Quick Start](docs/quick-start.md)
|
|
|
|
## Conceptual Guides
|
|
- [Architecture](docs/architecture.md)
|
|
- [Memory Access](docs/memory-access.md)
|
|
- [Execution Models](docs/execution-models.md)
|
|
- [Function Hooking](docs/hooking.md)
|
|
|
|
## Examples
|
|
- [Example 1: Basic Memory Operations](WhiteMagic.Examples/README.md#example-1-basic-memory-operations)
|
|
- [Example 2: Pattern Scanning](WhiteMagic.Examples/README.md#example-2-pattern-scanning)
|
|
- [Example 3: Execution Models](WhiteMagic.Examples/README.md#example-3-execution-models)
|
|
- [Example 4: Function Hooking](WhiteMagic.Examples/README.md#example-4-function-hooking)
|
|
- [Example 5: High-Level API](WhiteMagic.Examples/README.md#example-5-high-level-api)
|
|
|
|
## API Reference
|
|
- [API Documentation](api/index.md)
|
|
|
|
## Reference & Comparison
|
|
- [Library Comparison](docs/memory-library-comparison.md)
|
|
- [Troubleshooting](docs/troubleshooting.md)
|
|
|
|
## Contributing
|
|
- [Contributing Guidelines](CONTRIBUTING.md)
|