Skip to content

docs: update project structure and guidelines in AGENTS.md and CLAUDE.md#321

Merged
from2001 merged 1 commit intodevelopfrom
update/claude-agents-md
Jan 28, 2026
Merged

docs: update project structure and guidelines in AGENTS.md and CLAUDE.md#321
from2001 merged 1 commit intodevelopfrom
update/claude-agents-md

Conversation

@from2001
Copy link
Collaborator

This pull request updates documentation across the Unity client, Python server, and benchmark directories to reflect the transition to Unity 6, clarify project structure, and add details about new features and configuration options. The changes also expand internal component documentation, update usage instructions, and improve clarity and consistency throughout the guides.

Project Structure & Versioning Updates:

  • Updated all references to the Unity client version from Unity 6000.0.48f1 (or similar) to Unity 6, and clarified sample scene and package sample locations in AGENTS.md, CLAUDE.md, and related files. [1] [2] [3] [4]

Expanded Internal Component & Architecture Documentation:

  • Added detailed breakdowns of internal Unity client scripts and utilities, including new networking, serialization, smoothing, and utility components in both CLAUDE.md and architecture sections. [1] [2] [3]
  • Expanded descriptions of Python server architecture, including the configuration system, REST bridge, and configuration override priority.

Usage & Command Updates:

  • Updated simulator and server command examples to use the new Unity version and simplified server addresses (e.g., --server localhost instead of tcp://localhost). Added new simulator options and documented additional CLI/configuration arguments for both the server and benchmark tools. [1] [2] [3] [4] [5] [6]
  • Documented new server CLI options for logging and configuration, and clarified requirements for Python versions. [1] [2]

Benchmark & Testing Documentation Improvements:

  • Rewrote and expanded the benchmark project documentation, providing a quick start guide, environment variable/CLI argument descriptions, and Docker visualization stack instructions.
  • Updated benchmark and testing guidelines to clarify test locations and procedures.

Coding Style & Commit Guidelines:

  • Clarified and standardized coding style, naming conventions, and commit guidelines across all documentation, emphasizing the use of Conventional Commits and updated naming rules. [1] [2] [3]

These changes ensure that all documentation is up-to-date with the latest project structure, features, and best practices, and provide clearer guidance for developers working with any part of the codebase.

@from2001 from2001 merged commit 8bfa270 into develop Jan 28, 2026
@from2001 from2001 deleted the update/claude-agents-md branch January 28, 2026 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant