Skip to content
Merged
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@

# RuboCop cache
.rubocop-*
tasks/
29 changes: 19 additions & 10 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ Location: `.github/workflows/ci.yml`
3. Create validation contract in `src/validators.rb` (if needed)
4. Add tests in `spec/api_spec.rb`
5. Update README.md API Reference
6. Update API_DOCUMENTATION.md
6. Update docs/api/reference.md
7. Run tests and RuboCop

### Modifying Block/Blockchain Models
Expand All @@ -370,7 +370,7 @@ Location: `.github/workflows/ci.yml`
### Adjusting Rate Limits
1. Edit `config/rack_attack.rb`
2. Update README.md Rate Limiting table
3. Update API_DOCUMENTATION.md
3. Update docs/api/reference.md and docs/api/rate-limiting.md
4. Consider impact on user experience
5. Test with actual API calls

Expand All @@ -379,7 +379,7 @@ Location: `.github/workflows/ci.yml`
### Common Issues

**MongoDB Connection Errors**
- Ensure MongoDB is running: `docker-compose up -d mongodb`
- Ensure MongoDB is running: `docker-compose up -d db`
- Check `.env` has correct MONGO_DB_HOST, PORT, NAME
- For Docker: use `host: mongodb` not `localhost`

Expand Down Expand Up @@ -432,13 +432,22 @@ chain_forge/
β”‚ └── workflows/
β”‚ └── ci.yml # GitHub Actions CI pipeline
└── docs/
β”œβ”€β”€ README.md # Main user documentation
β”œβ”€β”€ CLAUDE.md # This file (Claude Code guidance)
β”œβ”€β”€ CHANGELOG.md # Version history
β”œβ”€β”€ CONTRIBUTING.md # Contribution guidelines
β”œβ”€β”€ SECURITY.md # Security policies
β”œβ”€β”€ API_DOCUMENTATION.md # Complete API reference
└── DEPLOYMENT.md # Production deployment guide
β”œβ”€β”€ README.md # Documentation index
β”œβ”€β”€ CLAUDE.md # This file (Claude Code guidance)
β”œβ”€β”€ CHANGELOG.md # Version history
β”œβ”€β”€ CONTRIBUTING.md # Contribution guidelines
β”œβ”€β”€ SECURITY.md # Security policies
β”œβ”€β”€ getting-started/ # Tutorial files
β”œβ”€β”€ architecture/ # Architecture documentation
β”œβ”€β”€ api/
β”‚ β”œβ”€β”€ reference.md # Complete API reference
β”‚ β”œβ”€β”€ examples.md # Code examples
β”‚ └── rate-limiting.md # Rate limiting guide
└── guides/
β”œβ”€β”€ development-setup.md
β”œβ”€β”€ testing-guide.md
β”œβ”€β”€ deployment-guide.md # Production deployment guide
└── troubleshooting.md
```

## Educational Objectives
Expand Down
Loading