fix: Header Re-Organization for Consistency and Readability - #497
Merged
JeanPhilippeKernel merged 1 commit intoJul 10, 2026
Merged
JeanPhilippeKernel merged 1 commit into
JeanPhilippeKernel merged 1 commit into
Conversation
MathewBensonCode
force-pushed
the
header-reorganization
branch
2 times, most recently
from
February 2, 2026 21:54
1fa0077 to
1c3b16f
Compare
MathewBensonCode
marked this pull request as draft
February 2, 2026 22:54
MathewBensonCode
force-pushed
the
header-reorganization
branch
from
February 3, 2026 10:18
1c3b16f to
b9abaee
Compare
MathewBensonCode
marked this pull request as ready for review
February 3, 2026 10:50
MathewBensonCode
force-pushed
the
header-reorganization
branch
from
February 6, 2026 17:23
b9abaee to
4c95667
Compare
MathewBensonCode
force-pushed
the
header-reorganization
branch
from
March 13, 2026 15:11
4c95667 to
93e6c50
Compare
MathewBensonCode
force-pushed
the
header-reorganization
branch
2 times, most recently
from
March 31, 2026 11:51
71875c3 to
c621aac
Compare
MathewBensonCode
force-pushed
the
header-reorganization
branch
from
July 3, 2026 20:41
c621aac to
d29b716
Compare
MathewBensonCode
marked this pull request as draft
July 3, 2026 20:44
MathewBensonCode
force-pushed
the
header-reorganization
branch
4 times, most recently
from
July 9, 2026 18:17
42d7131 to
f3cf3db
Compare
MathewBensonCode
marked this pull request as ready for review
July 9, 2026 19:19
JeanPhilippeKernel
requested changes
Jul 10, 2026
- Provide a consistent taxonomy for headers, where the libraries(ZEngine and Tetragrama) expose their Interface(the -I flag) as the root of the package and header naming is synchronized with namespaces - This is especially important in libraries like Tetragrama where you have headers from ZEngine and Tetragrama in the same header file - Make the CMake files cleaner and more consistent by having a uniform naming convention for the Targets - The naming is also now symetrical with the namespaces
MathewBensonCode
force-pushed
the
header-reorganization
branch
from
July 10, 2026 09:25
f3cf3db to
1dd1775
Compare
JeanPhilippeKernel
self-requested a review
July 10, 2026 10:54
JeanPhilippeKernel
approved these changes
Jul 10, 2026
JeanPhilippeKernel
left a comment
Owner
There was a problem hiding this comment.
Thanks for the re-org !
JeanPhilippeKernel
merged commit Jul 10, 2026
15af098
into
JeanPhilippeKernel:develop
22 checks passed
JeanPhilippeKernel
added a commit
that referenced
this pull request
Sep 3, 2026
…mpleted/ Verified every doc's completion claim against the actual codebase — file existence, key symbols, checklist items — rather than trusting the Status line alone. Two categories of finding: Checklist-hygiene gaps (real implementation, boxes just never ticked): render-resource-manager.md, vfs-ticket2/4/5. Ticked every item after confirming the referenced file/symbol/test exists. render-resource-manager.md also got a naming-divergence note — the doc's proposed GPUResource.h/ GPUBuffer/GPUImage shipped as GpuAllocator.h's BufferView/BufferImage instead; functionally identical, different names. Genuine correctness gap: fly-camera-redesign.md claimed 'Implemented' with every one of its own checklist items unchecked, and describes an entirely different architecture (FlyCameraInput/FlyCameraState/EditorCameraController) than what's actually in FlyCameraController.h (CamState enum, SetViewportRect self-gating). Corrected the status to flag this and pointed at the real design so a future reader isn't misled. memory-allocator-audit.md — added a scope note: its 13 bugs (#497/#531) are genuinely all fixed, but later, unrelated allocator bugs were found and fixed independently this cycle (#680-683, #697, #728, #731) — pointed to the wiki's Memory Management page for the current picture. Moved to ZEngine/docs/completed/ (verified, no open items): asset-manager.md, memory-allocator-audit.md, vfs-design.md, vfs-ticket2/3/4/5/6, gpu-allocator-rearchitecture.md, render-resource-manager.md, system-scheduler.md, ui-system.md. Left in place — genuinely partial: tlsf-allocator-integration.md (Phase 3 blocked), logging-policy.md (real outstanding verification/benchmark tasks), fly-camera-redesign.md (needs a content rewrite, not just a status fix), and everything already marked Design/Planning/In Progress/Partially implemented. Cross-checked every backtick-quoted reference to the 12 moved filenames across the rest of the docs tree — all are informal textual mentions, not markdown hyperlinks, so nothing broke.
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
2 participants
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.
This commit touches on many files, but the work done is mainly adding the name of the project and the full path to the actual header file. e.g. going from
#include <ZEngineDef.h>to#include <ZEngine/ZEngineDef.h>Related to #310 , there may be need to harmonize the structure of the CMakeFiles, either all match the ZEngine format with the Main subdirectory defining the project and then containing another subdirectory with the targets or to use the format in Tetragrama and Obelisk where the targets and project are in the main Subdirectory.