Add comprehensive codebase documentation (CLAUDE.md)#245
Open
xorpaul wants to merge 1 commit into
Open
Conversation
Documents codebase structure, all key source files and their functions, major data structures, development workflow, testing patterns, code conventions, CLI flags, and where to make changes for common tasks. https://claude.ai/code/session_01Xrzb4i425wBHwFutHicJd5
Member
|
I see no issue merging this. Just need to keep it up-to-date with changes we made in "old school manual way" :) |
jay7x
approved these changes
Apr 30, 2026
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
This PR adds a comprehensive developer guide (
CLAUDE.md) that documents the g10k codebase structure, architecture, and development practices. This guide serves as a reference for developers working on the project and provides context for AI-assisted development.Key Changes
CLAUDE.md— A 381-line developer guide covering:Notable Details
TestConfigXxx→tests/TestConfigXxx.yaml)This documentation improves developer onboarding and provides a single source of truth for codebase architecture and conventions.
https://claude.ai/code/session_01Xrzb4i425wBHwFutHicJd5