Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# AGENTS.md

This file provides guidance to AI agents (OpenAI Codex, etc.) when working with this repository.

## Context

**Read `llms.txt` first** for complete project context, architecture decisions, and coding conventions.

The `llms.txt` file references:
- `README.md` - Project overview and quick start
- `DEVELOPER_GUIDE.md` - Complete development workflow and setup

Read those files for detailed information. The `llms.txt` file provides a concise summary optimized for AI assistance.
28 changes: 28 additions & 0 deletions ARCHITECTURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Architecture Overview

This document describes the architecture of the Open Cap Table Protocol (OCP).

## Codebase Structure

- `chain/` - Smart contracts (Solidity, Foundry)
- `src/core/` - Core contracts (CapTable, CapTableFactory, Storage)
- `src/facets/` - Facet contracts
- `src/libraries/` - Shared libraries
- `src/interfaces/` - Contract interfaces
- `test/` - Foundry tests

- `src/` - Server code (Node.js/TypeScript)
- `routes/` - Route handlers
- `controllers/` - Business logic controllers
- `db/` - MongoDB models and operations
- `chain-operations/` - Blockchain interaction utilities
- `utils/` - Utility functions
- `fairmint/` - Fairmint integration
- `rxjs/` - Reactive data processing

## Related Documentation

- [Data Model](docs/DATA_MODEL.md) - Database schema
- [Configuration](CONFIG.md) - Environment setup
- [Developer Guide](DEVELOPER_GUIDE.md) - Development workflow
- [README](README.md) - Project overview
13 changes: 13 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CLAUDE.md

This file provides guidance to Claude Code when working with this repository.

## Context

**Read `llms.txt` first** for complete project context, architecture decisions, and coding conventions.

The `llms.txt` file references:
- `README.md` - Project overview and quick start
- `DEVELOPER_GUIDE.md` - Complete development workflow and setup

Read those files for detailed information. The `llms.txt` file provides a concise summary optimized for AI assistance.
Loading