tegwick
746a3f9df1
Move technical documentation from root directory to organized locations for better project structure and discoverability. Documentation Moved to docs/development/: - UserInterfaceFramework.md: UI component framework specification and architecture - LOST_FUNCTIONALITY_ANALYSIS.md: Technical analysis of recovered JavaScript functionality - TDD_COMPLIANCE_REPORT.md: Test-Driven Development methodology validation report Obsolete Documentation Archived: - TEST_ENVIRONMENT.md → history/javascript-dev-tests/ Manual testing environment docs (replaced by automated testing) Files Remaining in Root: - CHANGELOG.md: Project changelog (standard location) - TODO.md: Active project tasks (operational file) Benefits: - ✅ Clean root directory with only operational files - ✅ Technical documentation properly organized in docs/development/ - ✅ Obsolete docs archived with historical context - ✅ Improved project navigation and documentation discoverability - ✅ Follows standard project organization conventions Project Structure: - Root: Operational files (CHANGELOG, TODO) - docs/development/: Technical documentation and reports - history/: Archived development artifacts and obsolete documentation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| api | ||
| architecture | ||
| cost-analysis | ||
| development | ||
| integration | ||
| manuals | ||
| user-guides | ||
| advanced_packaging.md | ||
| agents | ||
| ASSET_MANAGEMENT_USER_GUIDE.md | ||
| CLI_TUTORIAL.md | ||
| graphql_interface.md | ||
| markitect.1 | ||
| md-explode-command.md | ||
| README.md | ||
| search.md | ||
| wishlist.md | ||
| workplan-testdrive-jsui-capability.md | ||
MarkiTect Documentation
Welcome to the MarkiTect documentation. This directory contains comprehensive documentation for developers, users, and contributors.
Documentation Structure
📐 Architecture Documentation (architecture/)
Deep technical documentation about system design, performance, and implementation details.
- Caching System - Why and how MarkiTect's AST caching delivers 60-85% performance improvements
- Coming soon: Database Schema, CLI Architecture, Plugin System
👥 User Guides (user-guides/)
End-user documentation for working with MarkiTect CLI and features.
- Coming soon: Getting Started, Command Reference, Best Practices
🔧 Development Documentation (development/)
Documentation for contributors and developers extending MarkiTect.
- Coming soon: Contributing Guide, Testing Strategy, Release Process
Quick Links
For Users
- Installation & Setup
- Command Reference (coming soon)
- Performance Guide (coming soon)
For Developers
- Architecture Overview - System design and component relationships
- Development Setup - Local development environment
- API Documentation (coming soon)
Project Management
- Project Status - Current development status
- Roadmap - Strategic development plan
- Current Tasks - Task management using Keep a Todofile format
Key Concepts
Core Architecture Principles
- Parse Once, Use Many Times - AST caching for 60-85% performance improvement
- Convention Over Configuration - Sensible defaults with minimal setup
- Schema-Driven Processing - Structured markdown with validation
- Relational Metadata - Database-powered document relationships
Performance Philosophy
MarkiTect treats markdown documents as structured, queryable data rather than plain text. This approach enables:
- Lightning-fast document processing through intelligent caching
- Complex querying and relationship management
- Schema validation and consistency enforcement
- Scalable performance that grows with your content
Contributing to Documentation
Documentation follows the same quality standards as code:
- Clear Structure - Logical organization and navigation
- Practical Examples - Real-world usage patterns
- Performance Context - Why architectural decisions matter
- User-Focused - Written for the intended audience
Documentation Standards
- Use clear, concise language
- Include practical examples
- Explain the "why" behind design decisions
- Keep technical accuracy as the highest priority
- Update docs when changing functionality
This documentation is maintained alongside the codebase. For the most current information, always refer to the latest version in the repository.