Documentation effort

[miguel-petersen]

Code is great, when people can understand it. So, let's make an effort to improve documentation.

The following list will be extended over time:

• [ ] Instruction set exposed
• [ ] Resource tokens / PRMT
• [ ] PRMT descriptor data uploading
• [ ] Shader program hosts
• [ ] Shader data hosts
• [ ] User command buffers / hooking
• [ ] SVOX
• [ ] Networking architecture (pretty important one)
• [ ] SPIRV compilation passes (write-up)
• [ ] DXIL compilation passes (write-up), many pages
• [ ] Versioning system
• [ ] Chunked messages
• [ ] Export streaming (multiple buffers)
• [ ] Shader instrumentation propagation / keys
• [ ] Instrumentation strategy (block vistation, nested instrumentation, etc...)
• [ ] Basic block instruction memory (not a simple thing)
• [ ] Plugin setup (everything is written as a plugin really)
• [ ] DX12 descriptor injection
• [ ] DX12 bootstrapping
• [ ] DX12 root register mapping
• [ ] DX12 gpu address tracking
• [ ] Vulkan SE descriptor set mapping and update-after-bind stuff
• [ ] Vulkan / DX12 code generation
• [ ] Patch command list
• [ ] Vulkan PRMT heap emulation
• [ ] Startup environments

Feel free to add as you see fit.