From ed33766c912d6004ee5ba1521502c3df0bfe8fcd Mon Sep 17 00:00:00 2001 From: tegwick Date: Wed, 29 Oct 2025 22:31:52 +0100 Subject: [PATCH] refactor: reorganize examples directory with topic-based subdirectories MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Reorganize examples directory into logical topic-based subdirectories with comprehensive documentation: - templates/: ISO/ARC42 documentation templates - asset-management/: Asset management prototypes and demos - essays/: Long-form content examples - invoicing/: Invoice generation examples - plugins/: Plugin development examples - issue-demos/: Issue prevention demonstrations - design-patterns/: Design pattern examples Each subdirectory includes a README.txt file with topic description and contributor signatures based on file creation timestamps. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- examples/asset-management/README.txt | 14 ++++++++++++++ .../asset_management_concept_a.py | 0 .../asset_management_concept_b.py | 0 .../demo_hash_store/demo_inputs/company_logo.png | 0 .../demo_hash_store/demo_inputs/diagram.png | 0 .../demo_hash_store/demo_inputs/logo.png | 0 .../demo_hash_store/metadata.db | Bin ...d2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png | 0 ...43d36f5db47021501baeac8ceeb3b726157de6ebf5.png | 0 .../demo_workspace/demo_assets/company_logo.png | 0 .../demo_workspace/demo_assets/diagram.png | 0 .../demo_workspace/demo_assets/logo.png | 0 .../documents/project_a/assets/diagram.png | 0 .../documents/project_a/assets/logo.png | 0 .../demo_workspace/documents/project_a/index.md | 0 .../documents/project_b/assets/company_logo.png | 0 .../documents/project_b/assets/system_diagram.png | 0 .../demo_workspace/documents/project_b/index.md | 0 .../demo_workspace/packages/project_a.mdpkg | Bin .../demo_workspace/packages/project_b.mdpkg | Bin ...d2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png | 0 ...43d36f5db47021501baeac8ceeb3b726157de6ebf5.png | 0 .../demo_workspace/shared_assets/registry.json | 0 examples/design-patterns/README.txt | 11 +++++++++++ examples/{ => design-patterns}/design_pattern.md | 0 examples/{ => essays}/BildungsKanonJon.html | 0 examples/{ => essays}/BildungsKanonJon.md | 0 examples/essays/README.txt | 12 ++++++++++++ examples/invoicing/README.txt | 11 +++++++++++ examples/{ => invoicing}/invoice_data.json | 0 examples/{ => invoicing}/invoice_template.md | 0 examples/issue-demos/README.txt | 11 +++++++++++ .../{ => issue-demos}/issue_59_prevention_demo.py | 0 examples/plugins/README.txt | 11 +++++++++++ examples/templates/README.txt | 13 +++++++++++++ examples/{ => templates}/TEMPLATE-ARC42.md | 0 examples/{ => templates}/TEMPLATE-ISO14001.md | 0 .../{ => templates}/TEMPLATE-ISO27001-ISMS.md | 0 examples/{ => templates}/TEMPLATE-ISO9001.md | 0 39 files changed, 83 insertions(+) create mode 100644 examples/asset-management/README.txt rename examples/{ => asset-management}/asset_management_concept_a.py (100%) rename examples/{ => asset-management}/asset_management_concept_b.py (100%) rename examples/{ => asset-management}/demo_hash_store/demo_inputs/company_logo.png (100%) rename examples/{ => asset-management}/demo_hash_store/demo_inputs/diagram.png (100%) rename examples/{ => asset-management}/demo_hash_store/demo_inputs/logo.png (100%) rename examples/{ => asset-management}/demo_hash_store/metadata.db (100%) rename examples/{ => asset-management}/demo_hash_store/store/sha256/25965a/25965aaacc4f361784870ed2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png (100%) rename examples/{ => asset-management}/demo_hash_store/store/sha256/54f88e/54f88ec7aa8570d4ad655943d36f5db47021501baeac8ceeb3b726157de6ebf5.png (100%) rename examples/{ => asset-management}/demo_workspace/demo_assets/company_logo.png (100%) rename examples/{ => asset-management}/demo_workspace/demo_assets/diagram.png (100%) rename examples/{ => asset-management}/demo_workspace/demo_assets/logo.png (100%) rename examples/{ => asset-management}/demo_workspace/documents/project_a/assets/diagram.png (100%) rename examples/{ => asset-management}/demo_workspace/documents/project_a/assets/logo.png (100%) rename examples/{ => asset-management}/demo_workspace/documents/project_a/index.md (100%) rename examples/{ => asset-management}/demo_workspace/documents/project_b/assets/company_logo.png (100%) rename examples/{ => asset-management}/demo_workspace/documents/project_b/assets/system_diagram.png (100%) rename examples/{ => asset-management}/demo_workspace/documents/project_b/index.md (100%) rename examples/{ => asset-management}/demo_workspace/packages/project_a.mdpkg (100%) rename examples/{ => asset-management}/demo_workspace/packages/project_b.mdpkg (100%) rename examples/{ => asset-management}/demo_workspace/shared_assets/images/25965aaacc4f361784870ed2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png (100%) rename examples/{ => asset-management}/demo_workspace/shared_assets/images/54f88ec7aa8570d4ad655943d36f5db47021501baeac8ceeb3b726157de6ebf5.png (100%) rename examples/{ => asset-management}/demo_workspace/shared_assets/registry.json (100%) create mode 100644 examples/design-patterns/README.txt rename examples/{ => design-patterns}/design_pattern.md (100%) rename examples/{ => essays}/BildungsKanonJon.html (100%) rename examples/{ => essays}/BildungsKanonJon.md (100%) create mode 100644 examples/essays/README.txt create mode 100644 examples/invoicing/README.txt rename examples/{ => invoicing}/invoice_data.json (100%) rename examples/{ => invoicing}/invoice_template.md (100%) create mode 100644 examples/issue-demos/README.txt rename examples/{ => issue-demos}/issue_59_prevention_demo.py (100%) create mode 100644 examples/plugins/README.txt create mode 100644 examples/templates/README.txt rename examples/{ => templates}/TEMPLATE-ARC42.md (100%) rename examples/{ => templates}/TEMPLATE-ISO14001.md (100%) rename examples/{ => templates}/TEMPLATE-ISO27001-ISMS.md (100%) rename examples/{ => templates}/TEMPLATE-ISO9001.md (100%) diff --git a/examples/asset-management/README.txt b/examples/asset-management/README.txt new file mode 100644 index 00000000..88731071 --- /dev/null +++ b/examples/asset-management/README.txt @@ -0,0 +1,14 @@ +Asset Management Examples + +This directory contains prototype implementations and demonstrations for asset management +concepts developed for Issue #141: + +- asset_management_concept_a.py: Hash-based content-addressable storage approach +- asset_management_concept_b.py: Alternative asset management implementation +- demo_hash_store/: Working demonstration of hash-based asset storage with metadata +- demo_workspace/: Example workspace showing asset management in practice + +These examples showcase different approaches to asset deduplication, storage, and +management within the MarkiTect ecosystem. + +--worsch, 25-10-08 \ No newline at end of file diff --git a/examples/asset_management_concept_a.py b/examples/asset-management/asset_management_concept_a.py similarity index 100% rename from examples/asset_management_concept_a.py rename to examples/asset-management/asset_management_concept_a.py diff --git a/examples/asset_management_concept_b.py b/examples/asset-management/asset_management_concept_b.py similarity index 100% rename from examples/asset_management_concept_b.py rename to examples/asset-management/asset_management_concept_b.py diff --git a/examples/demo_hash_store/demo_inputs/company_logo.png b/examples/asset-management/demo_hash_store/demo_inputs/company_logo.png similarity index 100% rename from examples/demo_hash_store/demo_inputs/company_logo.png rename to examples/asset-management/demo_hash_store/demo_inputs/company_logo.png diff --git a/examples/demo_hash_store/demo_inputs/diagram.png b/examples/asset-management/demo_hash_store/demo_inputs/diagram.png similarity index 100% rename from examples/demo_hash_store/demo_inputs/diagram.png rename to examples/asset-management/demo_hash_store/demo_inputs/diagram.png diff --git a/examples/demo_hash_store/demo_inputs/logo.png b/examples/asset-management/demo_hash_store/demo_inputs/logo.png similarity index 100% rename from examples/demo_hash_store/demo_inputs/logo.png rename to examples/asset-management/demo_hash_store/demo_inputs/logo.png diff --git a/examples/demo_hash_store/metadata.db b/examples/asset-management/demo_hash_store/metadata.db similarity index 100% rename from examples/demo_hash_store/metadata.db rename to examples/asset-management/demo_hash_store/metadata.db diff --git a/examples/demo_hash_store/store/sha256/25965a/25965aaacc4f361784870ed2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png b/examples/asset-management/demo_hash_store/store/sha256/25965a/25965aaacc4f361784870ed2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png similarity index 100% rename from examples/demo_hash_store/store/sha256/25965a/25965aaacc4f361784870ed2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png rename to examples/asset-management/demo_hash_store/store/sha256/25965a/25965aaacc4f361784870ed2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png diff --git a/examples/demo_hash_store/store/sha256/54f88e/54f88ec7aa8570d4ad655943d36f5db47021501baeac8ceeb3b726157de6ebf5.png b/examples/asset-management/demo_hash_store/store/sha256/54f88e/54f88ec7aa8570d4ad655943d36f5db47021501baeac8ceeb3b726157de6ebf5.png similarity index 100% rename from examples/demo_hash_store/store/sha256/54f88e/54f88ec7aa8570d4ad655943d36f5db47021501baeac8ceeb3b726157de6ebf5.png rename to examples/asset-management/demo_hash_store/store/sha256/54f88e/54f88ec7aa8570d4ad655943d36f5db47021501baeac8ceeb3b726157de6ebf5.png diff --git a/examples/demo_workspace/demo_assets/company_logo.png b/examples/asset-management/demo_workspace/demo_assets/company_logo.png similarity index 100% rename from examples/demo_workspace/demo_assets/company_logo.png rename to examples/asset-management/demo_workspace/demo_assets/company_logo.png diff --git a/examples/demo_workspace/demo_assets/diagram.png b/examples/asset-management/demo_workspace/demo_assets/diagram.png similarity index 100% rename from examples/demo_workspace/demo_assets/diagram.png rename to examples/asset-management/demo_workspace/demo_assets/diagram.png diff --git a/examples/demo_workspace/demo_assets/logo.png b/examples/asset-management/demo_workspace/demo_assets/logo.png similarity index 100% rename from examples/demo_workspace/demo_assets/logo.png rename to examples/asset-management/demo_workspace/demo_assets/logo.png diff --git a/examples/demo_workspace/documents/project_a/assets/diagram.png b/examples/asset-management/demo_workspace/documents/project_a/assets/diagram.png similarity index 100% rename from examples/demo_workspace/documents/project_a/assets/diagram.png rename to examples/asset-management/demo_workspace/documents/project_a/assets/diagram.png diff --git a/examples/demo_workspace/documents/project_a/assets/logo.png b/examples/asset-management/demo_workspace/documents/project_a/assets/logo.png similarity index 100% rename from examples/demo_workspace/documents/project_a/assets/logo.png rename to examples/asset-management/demo_workspace/documents/project_a/assets/logo.png diff --git a/examples/demo_workspace/documents/project_a/index.md b/examples/asset-management/demo_workspace/documents/project_a/index.md similarity index 100% rename from examples/demo_workspace/documents/project_a/index.md rename to examples/asset-management/demo_workspace/documents/project_a/index.md diff --git a/examples/demo_workspace/documents/project_b/assets/company_logo.png b/examples/asset-management/demo_workspace/documents/project_b/assets/company_logo.png similarity index 100% rename from examples/demo_workspace/documents/project_b/assets/company_logo.png rename to examples/asset-management/demo_workspace/documents/project_b/assets/company_logo.png diff --git a/examples/demo_workspace/documents/project_b/assets/system_diagram.png b/examples/asset-management/demo_workspace/documents/project_b/assets/system_diagram.png similarity index 100% rename from examples/demo_workspace/documents/project_b/assets/system_diagram.png rename to examples/asset-management/demo_workspace/documents/project_b/assets/system_diagram.png diff --git a/examples/demo_workspace/documents/project_b/index.md b/examples/asset-management/demo_workspace/documents/project_b/index.md similarity index 100% rename from examples/demo_workspace/documents/project_b/index.md rename to examples/asset-management/demo_workspace/documents/project_b/index.md diff --git a/examples/demo_workspace/packages/project_a.mdpkg b/examples/asset-management/demo_workspace/packages/project_a.mdpkg similarity index 100% rename from examples/demo_workspace/packages/project_a.mdpkg rename to examples/asset-management/demo_workspace/packages/project_a.mdpkg diff --git a/examples/demo_workspace/packages/project_b.mdpkg b/examples/asset-management/demo_workspace/packages/project_b.mdpkg similarity index 100% rename from examples/demo_workspace/packages/project_b.mdpkg rename to examples/asset-management/demo_workspace/packages/project_b.mdpkg diff --git a/examples/demo_workspace/shared_assets/images/25965aaacc4f361784870ed2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png b/examples/asset-management/demo_workspace/shared_assets/images/25965aaacc4f361784870ed2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png similarity index 100% rename from examples/demo_workspace/shared_assets/images/25965aaacc4f361784870ed2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png rename to examples/asset-management/demo_workspace/shared_assets/images/25965aaacc4f361784870ed2624f0178ea7c3cf33961ffb73ef13bafed7cd28c.png diff --git a/examples/demo_workspace/shared_assets/images/54f88ec7aa8570d4ad655943d36f5db47021501baeac8ceeb3b726157de6ebf5.png b/examples/asset-management/demo_workspace/shared_assets/images/54f88ec7aa8570d4ad655943d36f5db47021501baeac8ceeb3b726157de6ebf5.png similarity index 100% rename from examples/demo_workspace/shared_assets/images/54f88ec7aa8570d4ad655943d36f5db47021501baeac8ceeb3b726157de6ebf5.png rename to examples/asset-management/demo_workspace/shared_assets/images/54f88ec7aa8570d4ad655943d36f5db47021501baeac8ceeb3b726157de6ebf5.png diff --git a/examples/demo_workspace/shared_assets/registry.json b/examples/asset-management/demo_workspace/shared_assets/registry.json similarity index 100% rename from examples/demo_workspace/shared_assets/registry.json rename to examples/asset-management/demo_workspace/shared_assets/registry.json diff --git a/examples/design-patterns/README.txt b/examples/design-patterns/README.txt new file mode 100644 index 00000000..f97b2ccc --- /dev/null +++ b/examples/design-patterns/README.txt @@ -0,0 +1,11 @@ +Design Pattern Examples + +This directory contains examples of software design patterns and architectural concepts: + +- design_pattern.md: Documentation and examples of common design patterns used + in software development, with practical implementations and use cases + +These examples provide educational material for understanding and implementing +design patterns in real-world projects. + +--worsch, 25-10-03 \ No newline at end of file diff --git a/examples/design_pattern.md b/examples/design-patterns/design_pattern.md similarity index 100% rename from examples/design_pattern.md rename to examples/design-patterns/design_pattern.md diff --git a/examples/BildungsKanonJon.html b/examples/essays/BildungsKanonJon.html similarity index 100% rename from examples/BildungsKanonJon.html rename to examples/essays/BildungsKanonJon.html diff --git a/examples/BildungsKanonJon.md b/examples/essays/BildungsKanonJon.md similarity index 100% rename from examples/BildungsKanonJon.md rename to examples/essays/BildungsKanonJon.md diff --git a/examples/essays/README.txt b/examples/essays/README.txt new file mode 100644 index 00000000..dda91196 --- /dev/null +++ b/examples/essays/README.txt @@ -0,0 +1,12 @@ +Essays and Long-form Content + +This directory contains essay examples and long-form content demonstrations: + +- BildungsKanonJon.md: "200 Jahre Bildung" - A philosophical essay exploring 200 years + of education from the perspective of world spirit to self-consciousness +- BildungsKanonJon.html: Rendered HTML version of the essay + +These examples demonstrate MarkiTect's capability to handle complex, narrative content +with rich formatting and philosophical depth. + +--worsch, 25-10-08 \ No newline at end of file diff --git a/examples/invoicing/README.txt b/examples/invoicing/README.txt new file mode 100644 index 00000000..d97dc829 --- /dev/null +++ b/examples/invoicing/README.txt @@ -0,0 +1,11 @@ +Invoicing System Examples + +This directory contains examples for invoice generation and template systems: + +- invoice_template.md: Markdown template for invoice generation +- invoice_data.json: Sample invoice data in JSON format for template population + +These examples demonstrate how MarkiTect can be used for business document generation +with data-driven template systems. + +--worsch, 25-10-03 \ No newline at end of file diff --git a/examples/invoice_data.json b/examples/invoicing/invoice_data.json similarity index 100% rename from examples/invoice_data.json rename to examples/invoicing/invoice_data.json diff --git a/examples/invoice_template.md b/examples/invoicing/invoice_template.md similarity index 100% rename from examples/invoice_template.md rename to examples/invoicing/invoice_template.md diff --git a/examples/issue-demos/README.txt b/examples/issue-demos/README.txt new file mode 100644 index 00000000..5350e00e --- /dev/null +++ b/examples/issue-demos/README.txt @@ -0,0 +1,11 @@ +Issue Prevention Demonstrations + +This directory contains examples demonstrating issue prevention and resolution: + +- issue_59_prevention_demo.py: Demonstration script for preventing issues related + to Issue #59, showing best practices and defensive programming techniques + +These examples serve as educational material for avoiding common pitfalls and +implementing robust solutions. + +--worsch, 25-10-03 \ No newline at end of file diff --git a/examples/issue_59_prevention_demo.py b/examples/issue-demos/issue_59_prevention_demo.py similarity index 100% rename from examples/issue_59_prevention_demo.py rename to examples/issue-demos/issue_59_prevention_demo.py diff --git a/examples/plugins/README.txt b/examples/plugins/README.txt new file mode 100644 index 00000000..a91265ef --- /dev/null +++ b/examples/plugins/README.txt @@ -0,0 +1,11 @@ +Plugin Development Examples + +This directory contains example plugin implementations for MarkiTect: + +- example_processor.py: Example of a content processor plugin +- example_formatter.py: Example of a content formatter plugin + +These examples show how to extend MarkiTect's functionality through the plugin +architecture, providing templates for custom processing and formatting plugins. + +--worsch, 25-10-03 \ No newline at end of file diff --git a/examples/templates/README.txt b/examples/templates/README.txt new file mode 100644 index 00000000..e558215f --- /dev/null +++ b/examples/templates/README.txt @@ -0,0 +1,13 @@ +Templates Collection + +This directory contains various document templates for different standards and frameworks: + +- TEMPLATE-ARC42.md: Software architecture documentation template following the arc42 standard +- TEMPLATE-ISO14001.md: Environmental management system template based on ISO 14001 +- TEMPLATE-ISO27001-ISMS.md: Information security management system template for ISO 27001 +- TEMPLATE-ISO9001.md: Quality management system template following ISO 9001 + +These templates provide structured starting points for creating compliant documentation +in their respective domains. + +--worsch, 25-10-03 \ No newline at end of file diff --git a/examples/TEMPLATE-ARC42.md b/examples/templates/TEMPLATE-ARC42.md similarity index 100% rename from examples/TEMPLATE-ARC42.md rename to examples/templates/TEMPLATE-ARC42.md diff --git a/examples/TEMPLATE-ISO14001.md b/examples/templates/TEMPLATE-ISO14001.md similarity index 100% rename from examples/TEMPLATE-ISO14001.md rename to examples/templates/TEMPLATE-ISO14001.md diff --git a/examples/TEMPLATE-ISO27001-ISMS.md b/examples/templates/TEMPLATE-ISO27001-ISMS.md similarity index 100% rename from examples/TEMPLATE-ISO27001-ISMS.md rename to examples/templates/TEMPLATE-ISO27001-ISMS.md diff --git a/examples/TEMPLATE-ISO9001.md b/examples/templates/TEMPLATE-ISO9001.md similarity index 100% rename from examples/TEMPLATE-ISO9001.md rename to examples/templates/TEMPLATE-ISO9001.md