coulomb/markitect-main
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
An advanced markdown engine
368 commits 1 branch 0 tags 23 MiB
Find a file
tegwick f546f3c175 Add comprehensive documentation and package building target 
📚 Documentation:
- VERSION_MANAGEMENT.md: Complete setuptools-scm guide
- Enhanced PACKAGE_PUBLISHING.md: Full workflow documentation
- Version calculation examples and troubleshooting
- Release process and best practices

🎯 New Makefile Target:
- `make package`: Build distribution packages with version info
- Automatic cleanup and detailed package information
- Supports both wheel and source distributions

✨ Features Documented:
- Git tag-based version management
- Development vs release versions
- Complete release workflows
- Gitea registry integration
- CI/CD integration examples

🚀 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-08 21:18:18 +01:00
.claude feat: add Claude Code agent configuration and registration tools 2025-10-27 20:11:33 +01:00
.github/workflows feat: Implement comprehensive Testing Architecture Enhancement 2025-09-26 22:36:35 +02:00
.issues feat: Integrate Requirements Engineering Agent and fix Issue #59 test failures 2025-10-02 00:45:06 +02:00
.venv_old chore: Keep old venv from ubuntu 18.04 for now just in case. 2025-09-23 01:16:12 +02:00
agents feat: implement todofile system and retire NEXT.md 2025-10-25 02:48:45 +02:00
application feat: Implement domain logic separation with clean architecture 2025-09-26 22:15:45 +02:00
assets feat: complete Issue #146 final integration testing 2025-10-15 00:19:52 +02:00
capabilities feat: update kaizen-agentic submodule reference 2025-10-25 02:51:51 +02:00
cli refactor: remove obsolete issue management system in favor of issue-facade 2025-10-24 21:25:04 +02:00
config feat: Implement unified configuration management system 2025-09-26 17:45:56 +02:00
cost_notes feat: complete core asset management system with database integration 2025-10-14 23:42:42 +02:00
docs feat: implement todofile system and retire NEXT.md 2025-10-25 02:48:45 +02:00
domain fix: Eliminate all 111 test warnings by fixing root causes 2025-09-27 20:14:22 +02:00
examples feat: implement comprehensive asset shipping for md-render command 2025-10-29 23:12:44 +01:00
gitea Add complete Gitea package publishing support 2025-11-08 21:06:03 +01:00
guides chore: history cleanup 2025-10-03 03:39:43 +02:00
history feat: organize and archive legacy files to history directory 2025-10-25 02:55:23 +02:00
infrastructure refactor: remove obsolete issue management system in favor of issue-facade 2025-10-24 21:25:04 +02:00
markitect Convert to setuptools-scm for automatic version management 2025-11-08 20:23:16 +01:00
node_modules refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
reports feat: complete Issue #146 - Asset Management Implementation Milestone 2025-10-14 18:29:37 +02:00
services refactor: remove obsolete issue management system in favor of issue-facade 2025-10-24 21:25:04 +02:00
src chore: update project state and prepare for image support development 2025-10-26 08:06:22 +01:00
test_document_extracted feat: complete Issue #151 - Phase 4: Integration and Documentation 2025-10-14 11:11:51 +02:00
testdata chore: history cleanup 2025-10-03 03:39:43 +02:00
tests refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
todo chore: some cleanup and houskeeping 2025-10-06 22:51:38 +02:00
tools feat: add Claude Code agent configuration and registration tools 2025-10-27 20:11:33 +01:00
wiki@8818df03d3 chore: commit examples and some cleanup 2025-10-08 10:14:51 +02:00
.clinerules feat: implement markitect installer with version/release commands (issue #80) 2025-10-03 05:47:02 +02:00
.gitignore Convert to setuptools-scm for automatic version management 2025-11-08 20:23:16 +01:00
.gitmodules feat: add kaizen-agentic as submodule capability 2025-10-25 02:26:16 +02:00
aliases.sh feat: implement plugin-based architecture with md- command prefixes - Issue #44 2025-10-06 16:46:26 +02:00
asset_registry.json chore: update asset registry from recent operations 2025-10-20 07:23:40 +02:00
CHANGELOG.md Prepare release 0.7.0 2025-11-08 19:24:52 +01:00
debug_buttons.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
debug_floating_menu.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
demo_clean_editor.html chore: update project state and prepare for image support development 2025-10-26 08:06:22 +01:00
e2e_tests.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
final_functionality_verification.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
install feat: comprehensive asset management system and testing improvements 2025-10-12 19:57:31 +02:00
install.py feat: implement markitect installer with version/release commands (issue #80) 2025-10-03 05:47:02 +02:00
install.sh feat: implement markitect installer with version/release commands (issue #80) 2025-10-03 05:47:02 +02:00
LOST_FUNCTIONALITY_ANALYSIS.md feat: implement comprehensive JavaScript functionality recovery using TDD 2025-11-02 10:01:11 +01:00
Makefile Add comprehensive documentation and package building target 2025-11-08 21:18:18 +01:00
package-lock.json refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
package.json refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
PACKAGE_PUBLISHING.md Add comprehensive documentation and package building target 2025-11-08 21:18:18 +01:00
pyproject.toml Convert to setuptools-scm for automatic version management 2025-11-08 20:23:16 +01:00
pytest-timeout.ini feat: Implement test timeout infrastructure and fix failing tests 2025-10-01 18:07:05 +02:00
pytest.ini fix: eliminate all test suite warnings - Issue #129 2025-10-06 02:11:28 +02:00
release.py Add complete Gitea package publishing support 2025-11-08 21:06:03 +01:00
release_old_manual.py Finalize release script transition 2025-11-08 20:23:53 +01:00
release_simplified.py Convert to setuptools-scm for automatic version management 2025-11-08 20:23:16 +01:00
TDD_COMPLIANCE_REPORT.md refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_advanced_image_editor.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_alt_text_margin_layout.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_bulk_operations.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_button_functionality.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_buttons_top_alttext_bottom.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_cancel_button_debug.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_click_propagation_fix.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_component_positioning.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_comprehensive_section_styling.js fix: resolve critical JavaScript errors preventing content rendering 2025-11-02 16:28:20 +01:00
test_comprehensive_status_dialog.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_concurrent_editing.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_content_rendering_validation.js fix: resolve critical JavaScript errors preventing content rendering 2025-11-02 16:28:20 +01:00
test_dialog_fixes.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_dialog_positioning.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_dom_events.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_dom_integration.html chore: update project state and prepare for image support development 2025-10-26 08:06:22 +01:00
test_e2e_comprehensive.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_e2e_focused.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_enhanced_dom_events.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
TEST_ENVIRONMENT.md feat: implement comprehensive JavaScript functionality recovery using TDD 2025-11-02 10:01:11 +01:00
test_exact_overlay_positioning.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_filename_generation.js feat: implement comprehensive JavaScript functionality recovery using TDD 2025-11-02 10:01:11 +01:00
test_fixed_functionality.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_floating_control_panel.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_floating_draggable_menu.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_floating_status_removed.js remove: eliminate floating status panel above editor menu 2025-11-02 21:19:16 +01:00
test_get_all_sections.js feat: implement comprehensive JavaScript functionality recovery using TDD 2025-11-02 10:01:11 +01:00
test_image_editor_debug.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_image_functionality_fix.js fix: resolve reset all function and image changing functionality issues 2025-11-02 16:36:17 +01:00
test_image_rendering.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_image_reset_debug.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_image_section_buttons.js fix: resolve accept, reset, and cancel buttons in image section editing 2025-11-02 16:43:41 +01:00
test_image_ui_closure.js fix: ensure accept, cancel, and reset buttons properly close image editing UI 2025-11-02 16:49:58 +01:00
test_improved_image_workflow.js feat: implement advanced image editing with drop zone and staging workflow 2025-11-02 16:57:30 +01:00
test_keyboard_shortcuts.js feat: implement comprehensive JavaScript functionality recovery using TDD 2025-11-02 10:01:11 +01:00
test_message_system.js feat: implement comprehensive JavaScript functionality recovery using TDD 2025-11-02 10:01:11 +01:00
test_message_system_enhanced.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_method_check.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_real_functionality.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_reopen_issue.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_reset_functionality.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_reset_to_original.js fix: reset button now resets to original content like reset all function 2025-11-02 17:07:42 +01:00
test_responsive_overlay_ui.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_runner.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_section_click_debug.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_section_click_functionality.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_section_id_generation.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_section_splitting.js feat: implement comprehensive JavaScript functionality recovery using TDD 2025-11-02 10:01:11 +01:00
test_section_type_detection.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_startedit_ui_issue.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_state_management.js feat: implement comprehensive JavaScript functionality recovery using TDD 2025-11-02 10:01:11 +01:00
test_status_tracking.js feat: implement comprehensive JavaScript functionality recovery using TDD 2025-11-02 10:01:11 +01:00
test_text_editor_buttons.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_unified_floating_system.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
test_x_button.js refactor: Still trying to reorganize edit mode to be more robust 2025-11-04 21:59:22 +01:00
TODO.md feat: complete JavaScript architecture refactoring with TDD methodology 2025-11-03 20:15:26 +01:00
UserInterfaceFramework.md feat: implement insert mode with heading protection and fix content display bugs 2025-10-28 23:55:21 +01:00
VERSION_MANAGEMENT.md Add comprehensive documentation and package building target 2025-11-08 21:18:18 +01:00

docs/README.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

For Developers

Project Management

Key Concepts

Core Architecture Principles

  1. Parse Once, Use Many Times - AST caching for 60-85% performance improvement
  2. Convention Over Configuration - Sensible defaults with minimal setup
  3. Schema-Driven Processing - Structured markdown with validation
  4. 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:

  1. Clear Structure - Logical organization and navigation
  2. Practical Examples - Real-world usage patterns
  3. Performance Context - Why architectural decisions matter
  4. 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.