Skip to content

Add CLAUDE.md for AI agent development guidance #714

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add CLAUDE.md for AI agent development guidance #714

wants to merge 1 commit into from

Conversation

@micahstubbs
Copy link
Contributor

Summary

  • Adds CLAUDE.md file with comprehensive guidance for AI agents working with this codebase
  • Provides essential development commands, architecture overview, and build system details
  • Documents core dependencies, file structure, and performance considerations

What this enables

  • AI agents can quickly understand the codebase structure without exploring multiple files
  • Clear guidance on build commands (yarn build, yarn dev) and development workflow
  • Architecture overview covering ThreeJS, Kapsule framework, and force simulation engines
  • Documentation of examples structure and usage patterns

Contents

  • Development commands and build system (Rollup configuration)
  • Core file structure and component architecture
  • Dependencies and integration patterns (ThreeJS, Kapsule, three-forcegraph)
  • Examples structure and performance optimization guidance
  • Data format expectations and key features overview

This addresses the need for better AI agent onboarding and development efficiency in this visualization library.

Fix #713

Add CLAUDE.md for AI agent development guidance
7ccb734 
This file provides essential guidance to Claude Code and other AI agents
when working with the 3d-force-graph codebase, including:

- Development commands (build, dev)
- Architecture overview and file structure
- Build system configuration
- Core dependencies and patterns
- Example structure and usage
- Performance considerations

Helps AI agents quickly understand the codebase structure, build process,
and architectural patterns without needing to explore multiple files.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Summarize project for AI agents

1 participant

@micahstubbs