Docs/ai instructions and developer docs#68
Merged
Conversation
… developer documentation
Add 4 comprehensive Getting Started guides for new SPIN developers: - Quick-Start.md: 5-minute setup guide covering installation, first route creation, and endpoint testing - Project-Structure.md: Framework and application directory layout, configuration files, and code organization conventions - Core-Concepts.md: JSON routing, middleware pipeline, request-response cycle, and global helpers with examples - Your-First-App.md: Complete step-by-step tutorial building a Task Management API with CRUD operations, controllers, services, and testing instructions All guides include code examples, JSON configuration samples, and cross- references to related User Guide documentation. Updated doc/README.md to prominently feature the new guides in Getting Started section.
- Application-Design.md: separation of concerns, layered architecture, DI patterns - Error-Handling.md: exception hierarchy, JSON responses, logging strategies - Performance-Optimization.md: caching, query optimization, middleware efficiency - Database-Patterns.md: connections, transactions, data validation, migrations - Caching-Strategies.md: when/what to cache, invalidation, adapter selection - Testing-Patterns.md: unit/integration tests, mocking, fixtures, coverage Each guide (~450 words) covers practical patterns with real examples and trade-offs. Cross-referenced with User-Guide and other Best-Practices.
Create comprehensive recipe documentation covering: - Task 16: Authentication.md (JWT, sessions, middleware, testing) - Task 17: File-Uploads.md (validation, security, storage, error handling) - Task 18: Rate-Limiting.md (middleware, Redis, per-user limits) - Task 19: CORS-Handling.md (headers, preflight, configuration) - Task 20: API-Versioning.md (URL/header-based, adapters, deprecation) - Task 21: Deployment.md (config, migrations, health checks, blue-green) Each guide includes: - Problem statement - Complete, runnable code examples - Configuration examples - Testing approaches - Best practices and related docs Addresses Tasks 16-21 from AI Instructions and Developer Docs plan.
Add 6 detailed contributor guides covering framework development: - Getting-Started.md: Dev environment setup, git workflow, testing - Architecture-Overview.md: Core design, components, request lifecycle - Extension-Points.md: Custom adapters, drivers, middleware, helpers - Testing-Guide.md: Test structure, coverage, CI/CD integration - Code-Standards.md: PSR compliance, naming, docblocks, review checklist - Submitting-Changes.md: PR process, changelog, breaking changes, releases - README.md: Navigation and quick reference Includes code examples, checklists, test patterns, and detailed migration guides for breaking changes. Ready for framework contributors.
Task 28: Create API Reference Guide - doc/Reference/API-Reference.md with comprehensive coverage (~1500 words) - Core classes: Application, Controller, Middleware, Config, Logger, CacheManager, ConnectionManager - Helper functions: env, app, config, container, logger, db, cache, request/response, param accessors - Exception types: SpinException, ConfigException, DatabaseException, CacheException, MiddlewareException - Manager classes with configuration examples - Method signatures with type hints and usage examples Task 29: Update CLAUDE.md - Add "AI Instructions" section after Key Architectural Decisions - Reference three instruction files with brief descriptions - Maintain existing content Task 30: Update README.md - Replace documentation section with improved structure - Add quick navigation table with topic links - Reference doc/README.md as navigation hub - Maintain all other content Task 31: Final Verification - Verified all files exist: * .claude/claude-instructions.md * .github/copilot-instructions.md * .claude/llm-instructions.md * doc/README.md * doc/Getting-Started/* (4 files) * doc/User-Guide/* (10 files) * doc/Best-Practices/* (6 files) * doc/Recipes/* (6 files) * doc/Contributor-Guide/* (6+ files) * doc/Reference/API-Reference.md (NEW) - Total markdown files in doc/: 35 - Commits verified and documentation complete All Tasks 28-31 complete. Framework documentation suite ready for handoff.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.