docs: add header documentation for arcade machine components#93
Open
seventhback777 wants to merge 1 commit into
Open
docs: add header documentation for arcade machine components#93seventhback777 wants to merge 1 commit into
seventhback777 wants to merge 1 commit into
Conversation
Add about.md files describing the purpose and responsibilities of each module in the codebase: - include/about.md: documents all 23+ header files and their roles - src/about.md: overview of source file implementations - stats/about.md: placeholder for statistics output - resources/about.md: describes resource file structure and bundling - .scripts/README.md: documents generate-stats.sh and test-menu.cpp
RealH4D35
approved these changes
May 23, 2026
RealH4D35
left a comment
RealH4D35
left a comment
There was a problem hiding this comment.
Review
Summary
Adds about.md files that describe the purpose of key headers, source files, resources, stats, and helper scripts. This is a valuable addition for new contributors.
Minor suggestions
.scripts/README.md– Clarify thattest-menu.cppis not yet integrated into the main build.include/about.md– Fix minor formatting (e.g., indentation forConfigData.hfields) and consider linking related files (e.g.,GridLayout.h/cell.h).stats/about.md– Add a note that this folder is generated bygenerate-stats.sh, not manually edited.
No functional changes – documentation only.
Ready to merge. (The suggestions are non‑blocking.)
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.
Summary
Test plan