mirror of
https://github.com/johndoe6345789/low-code-react-app-b.git
synced 2026-04-26 06:34:54 +00:00
97 lines
5.6 KiB
Markdown
97 lines
5.6 KiB
Markdown
# 📚 CodeForge Documentation
|
|
|
|
Welcome to the CodeForge documentation center. This folder contains all technical documentation, guides, and references for the project.
|
|
|
|
## 🗂️ Documentation Structure
|
|
|
|
### 📖 Getting Started
|
|
- **[../README.md](../README.md)** - Main project README with quick start guide
|
|
- **[PRD.md](./PRD.md)** - Complete Product Requirements Document
|
|
- **[QUICKSTART_HOOKS.md](./guides/QUICKSTART_HOOKS.md)** - Quick start for using hooks
|
|
- **[QUICK_REFERENCE.md](./guides/QUICK_REFERENCE.md)** - Fast lookup guide
|
|
|
|
### 🏗️ Architecture
|
|
- **[DECLARATIVE_SYSTEM.md](./architecture/DECLARATIVE_SYSTEM.md)** - ⭐ JSON-driven page orchestration
|
|
- **[ARCHITECTURE_VISUAL_GUIDE.md](./architecture/ARCHITECTURE_VISUAL_GUIDE.md)** - Visual architecture diagrams
|
|
- **[CONFIG_ARCHITECTURE.md](./architecture/CONFIG_ARCHITECTURE.md)** - Configuration system overview
|
|
- **[JSON_ORCHESTRATION_COMPLETE.md](./architecture/JSON_ORCHESTRATION_COMPLETE.md)** - Complete JSON orchestration guide
|
|
- **[JSON_ORCHESTRATION_GUIDE.md](./architecture/JSON_ORCHESTRATION_GUIDE.md)** - JSON page building guide
|
|
|
|
#### Atomic Design (Legacy)
|
|
- **[ATOMIC_README.md](./architecture/atomic/ATOMIC_README.md)** - Atomic design quick start
|
|
- **[ATOMIC_COMPONENTS.md](./architecture/atomic/ATOMIC_COMPONENTS.md)** - Complete atomic architecture
|
|
- **[ATOMIC_REFACTOR_SUMMARY.md](./architecture/atomic/ATOMIC_REFACTOR_SUMMARY.md)** - Refactor overview
|
|
- **[ATOMIC_USAGE_EXAMPLES.md](./architecture/atomic/ATOMIC_USAGE_EXAMPLES.md)** - Code examples
|
|
- **[ATOMIC_VISUAL_OVERVIEW.md](./architecture/atomic/ATOMIC_VISUAL_OVERVIEW.md)** - Visual component maps
|
|
- **[COMPONENT_MAP.md](./architecture/atomic/COMPONENT_MAP.md)** - Component dependency maps
|
|
|
|
### 🎣 Hooks & API Reference
|
|
- **[COMPLETE_HOOK_LIBRARY.md](./api/COMPLETE_HOOK_LIBRARY.md)** - Complete hook API reference
|
|
- **[HOOK_LIBRARY_DOCS.md](./api/HOOK_LIBRARY_DOCS.md)** - Hook library documentation
|
|
- **[HOOK_LIBRARY_REFERENCE.md](./api/HOOK_LIBRARY_REFERENCE.md)** - Hook reference guide
|
|
|
|
### 📘 Guides
|
|
- **[PWA_GUIDE.md](./guides/PWA_GUIDE.md)** - Progressive Web App features
|
|
- **[CI_CD_GUIDE.md](./guides/CI_CD_GUIDE.md)** - CI/CD setup and configuration
|
|
- **[ERROR_REPAIR_GUIDE.md](./guides/ERROR_REPAIR_GUIDE.md)** - Error detection and repair
|
|
- **[SEED_DATA_GUIDE.md](./guides/SEED_DATA_GUIDE.md)** - Seed data templates
|
|
- **[PROPS_CONFIG_GUIDE.md](./guides/PROPS_CONFIG_GUIDE.md)** - Props configuration
|
|
- **[MIGRATION_GUIDE.md](./guides/MIGRATION_GUIDE.md)** - Migration between versions
|
|
- **[FAVICON_DESIGNER_ACCESS.md](./guides/FAVICON_DESIGNER_ACCESS.md)** - Favicon designer usage
|
|
|
|
### 🧪 Testing
|
|
- **[RUN_TESTS.md](./testing/RUN_TESTS.md)** - Test execution guide
|
|
- **[E2E_TEST_SUMMARY.md](./testing/E2E_TEST_SUMMARY.md)** - E2E test coverage
|
|
- **[SMOKE_TEST_REPORT.md](./testing/SMOKE_TEST_REPORT.md)** - Smoke test report
|
|
- **[SMOKE_TEST_QUICK_REF.md](./testing/SMOKE_TEST_QUICK_REF.md)** - Quick smoke test reference
|
|
- **[CONNECTION_TEST_PLAN.md](./testing/CONNECTION_TEST_PLAN.md)** - Connection testing plan
|
|
|
|
### 🚀 Deployment & Operations
|
|
- **[CI_FIX_SUMMARY.md](./deployment/CI_FIX_SUMMARY.md)** - CI/CD fixes
|
|
- **[BAD_GATEWAY_FIX.md](./deployment/BAD_GATEWAY_FIX.md)** - Bad gateway troubleshooting
|
|
|
|
### 📝 Development History
|
|
- **[REFACTORING_PLAN.md](./history/REFACTORING_PLAN.md)** - Initial refactoring plan
|
|
- **[REFACTORING_LOG.md](./history/REFACTORING_LOG.md)** - Refactoring activity log
|
|
- **[REFACTORING_SUMMARY.md](./history/REFACTORING_SUMMARY.md)** - Refactoring summary
|
|
- **[REFACTORING_EXAMPLE.md](./history/REFACTORING_EXAMPLE.md)** - Example refactors
|
|
- **[REFACTOR_PHASE2.md](./history/REFACTOR_PHASE2.md)** - Phase 2 refactor
|
|
- **[REFACTOR_PHASE3.md](./history/REFACTOR_PHASE3.md)** - Phase 3 refactor
|
|
- **[PHASE2_REFACTORING_SUMMARY.md](./history/PHASE2_REFACTORING_SUMMARY.md)** - Phase 2 summary
|
|
- **[PHASE3_COMPLETE.md](./history/PHASE3_COMPLETE.md)** - Phase 3 completion
|
|
- **[PHASE4_IMPLEMENTATION_COMPLETE.md](./history/PHASE4_IMPLEMENTATION_COMPLETE.md)** - Phase 4 completion
|
|
- **[REFACTOR_PHASE4_COMPLETE.md](./history/REFACTOR_PHASE4_COMPLETE.md)** - Phase 4 refactor
|
|
- **[DELIVERY_COMPLETE.md](./history/DELIVERY_COMPLETE.md)** - Delivery milestones
|
|
|
|
### 📋 Reference
|
|
- **[INDEX.md](./reference/INDEX.md)** - Documentation index
|
|
- **[ATOMIC_DOCS_INDEX.md](./reference/ATOMIC_DOCS_INDEX.md)** - Atomic design index
|
|
- **[EXAMPLE_NEW_PAGE.md](./reference/EXAMPLE_NEW_PAGE.md)** - New page examples
|
|
- **[AGENTS.md](./reference/AGENTS.md)** - AI agent architecture
|
|
- **[APP_STATUS.md](./reference/APP_STATUS.md)** - Application status
|
|
- **[ROADMAP.md](./reference/ROADMAP.md)** - Product roadmap
|
|
- **[SECURITY.md](./reference/SECURITY.md)** - Security guidelines
|
|
|
|
## 🔍 Quick Navigation
|
|
|
|
### I want to...
|
|
- **Add a new page** → [DECLARATIVE_SYSTEM.md](./architecture/DECLARATIVE_SYSTEM.md)
|
|
- **Use hooks in my components** → [COMPLETE_HOOK_LIBRARY.md](./api/COMPLETE_HOOK_LIBRARY.md)
|
|
- **Understand the architecture** → [ARCHITECTURE_VISUAL_GUIDE.md](./architecture/ARCHITECTURE_VISUAL_GUIDE.md)
|
|
- **Set up CI/CD** → [CI_CD_GUIDE.md](./guides/CI_CD_GUIDE.md)
|
|
- **Run tests** → [RUN_TESTS.md](./testing/RUN_TESTS.md)
|
|
- **Enable PWA features** → [PWA_GUIDE.md](./guides/PWA_GUIDE.md)
|
|
- **Fix errors** → [ERROR_REPAIR_GUIDE.md](./guides/ERROR_REPAIR_GUIDE.md)
|
|
|
|
## 📞 Need Help?
|
|
|
|
1. Check the relevant guide in this documentation
|
|
2. Review the [Quick Reference](./guides/QUICK_REFERENCE.md)
|
|
3. Look at [Example implementations](./reference/EXAMPLE_NEW_PAGE.md)
|
|
4. Check the [Roadmap](./reference/ROADMAP.md) for planned features
|
|
|
|
---
|
|
|
|
**Last Updated**: January 2026
|
|
**Documentation Version**: 6.0
|