Skip to content

Add CLAUDE.md documentation for project structure and conventions#1

Open
vbargl wants to merge 1 commit into
mainfrom
claude/claude-md-ml2894vefetd2p23-TWqdV
Open

Add CLAUDE.md documentation for project structure and conventions#1
vbargl wants to merge 1 commit into
mainfrom
claude/claude-md-ml2894vefetd2p23-TWqdV

Conversation

@vbargl
Copy link
Copy Markdown
Owner

@vbargl vbargl commented Jan 31, 2026

Summary

Add comprehensive developer documentation (CLAUDE.md) that outlines the ZeroTier CLI tool's architecture, build process, project structure, and key conventions.

Changes

  • New file: CLAUDE.md with complete project overview including:
    • Build and run instructions
    • Project directory structure and purpose of each module
    • Key naming conventions (command files, platform-specific files, generated code)
    • CLI architecture and command patterns
    • Configuration system details
    • Dependencies and their purposes
    • Go patterns and idioms used throughout the codebase

Details

This documentation serves as a reference guide for developers working on the project, covering:

  • How to build, run, and generate code
  • Where to find specific functionality (commands, config, API client, etc.)
  • Important conventions to follow when adding new features
  • Architecture decisions (Cobra CLI framework, auto-generated OpenAPI client, custom error types)
  • Current project status (e.g., set command is WIP)

This is a documentation-only change with no impact on functionality.

https://claude.ai/code/session_018DQDABspBNztsxkME5JFfu

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.

2 participants