Skip to content

Add project documentation#48

Draft
laurahuysamen wants to merge 2 commits intomasterfrom
claude-init
Draft

Add project documentation#48
laurahuysamen wants to merge 2 commits intomasterfrom
claude-init

Conversation

@laurahuysamen
Copy link

Summary

  • Add ARCHITECTURE.md with system boundary diagrams (Mermaid), component responsibilities, connection lifecycle, protocol layers, and key design decisions
  • Add CONTRIBUTING.md with prerequisites, build/test/lint commands, code conventions, release process, and PR guidelines
  • Add CLAUDE.md with AI agent guidance, key commands quick-reference, directory overview, important code patterns, and domain glossary

Test plan

  • Verify all file references in the docs point to existing files
  • Confirm Mermaid diagrams render correctly on GitHub
  • Review content accuracy against current codebase

Initialize comprehensive project documentation for the chisel fork:
- ARCHITECTURE.md with system diagrams and design decisions
- CONTRIBUTING.md with build, test, and PR guidelines
- CLAUDE.md with AI agent guidance and quick-reference
@laurahuysamen laurahuysamen requested a review from a team as a code owner March 5, 2026 13:05
@laurahuysamen laurahuysamen marked this pull request as draft March 5, 2026 13:06
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