refactor: reorganize examples directory with topic-based subdirectories
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 <noreply@anthropic.com>
This commit is contained in:
14
examples/asset-management/README.txt
Normal file
14
examples/asset-management/README.txt
Normal file
@@ -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
|
||||
11
examples/design-patterns/README.txt
Normal file
11
examples/design-patterns/README.txt
Normal file
@@ -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
|
||||
12
examples/essays/README.txt
Normal file
12
examples/essays/README.txt
Normal file
@@ -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
|
||||
11
examples/invoicing/README.txt
Normal file
11
examples/invoicing/README.txt
Normal file
@@ -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
|
||||
11
examples/issue-demos/README.txt
Normal file
11
examples/issue-demos/README.txt
Normal file
@@ -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
|
||||
11
examples/plugins/README.txt
Normal file
11
examples/plugins/README.txt
Normal file
@@ -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
|
||||
13
examples/templates/README.txt
Normal file
13
examples/templates/README.txt
Normal file
@@ -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
|
||||
Reference in New Issue
Block a user