Add comprehensive developer documentation and environment setup#447
Merged
Conversation
… agent efficacy - CLAUDE.md: comprehensive onboarding guide covering project overview, monorepo package roles, prerequisites, dev commands, Electron process model, IPC event system, dual-mode web app, Zustand state architecture, domain concepts, code style conventions, logging/error-handling patterns, testing setup, and known gotchas - .cursorrules: augmented with state management (Zustand slices), IPC event conventions, Effection async patterns, roarr logging, and serialize-error usage - .env.example: documents required Discogs API environment variables https://claude.ai/code/session_019upBEByJrhS932LwBV5q2C
|
Align table columns and reformat Effection code snippet to satisfy the check-format CI step. https://claude.ai/code/session_019upBEByJrhS932LwBV5q2C
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
This PR adds comprehensive developer documentation and environment configuration files to help contributors understand the Raga codebase architecture, development workflows, and coding conventions.
Changes
CLAUDE.md — New comprehensive code guide covering:
.cursorrules — Updated with additional development guidelines:
.env.example — New environment configuration template:
Implementation Details
The documentation is structured to serve both as onboarding material for new contributors and as a reference guide for ongoing development. It emphasizes the three-process Electron architecture, the IPC event system as the primary integration point, and the importance of using established patterns (Zustand slices, Effection generators, roarr logging) for consistency across the codebase.
https://claude.ai/code/session_019upBEByJrhS932LwBV5q2C