Miscellaneous cleanup - #112
Draft
tdecroyere wants to merge 3 commits into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Collect small, self-contained cleanup work before the next larger Elemental architecture iteration.
Current changes:
Additional small cleanups may be added to this PR as they are identified during the cleanup pass.
Sample documentation
The sample documentation now distinguishes between:
samples/Elementalexamples focused on the public runtime API;samples/Demosexperiments used as R&D/stress laboratories;samples/ElementalToolscommand-line examples for offline shader and asset processing.The READMEs describe the actual current code paths, controls and limitations. In particular, AITraining is documented as a CPU baseline rather than an already GPU-accelerated ML sample, and the sample
.scene/.textureformats are explicitly not presented as stable public Elemental formats.Scope
This PR is intentionally limited to cleanup and maintenance work. It should not opportunistically redesign major Elemental APIs or absorb the upcoming GPU virtual-memory architecture work.
Validation
Documentation-only so far. The sample documentation was checked against the current source files and CMake targets on the PR branch. Further validation notes will be added if code changes are included later.