Skip to content

DOCUMENTATION_INDEX.md

Latest commit

 

History

History
355 lines (257 loc) · 11.1 KB

DOCUMENTATION_INDEX.md

File metadata and controls

355 lines (257 loc) · 11.1 KB

Documentation Map - chaM3Leon

Quick Guide: Find the document you need quickly!

Quick Start - Start here!

If you are... Start from... Then go to...
Manager/Business SUMMARY.md VALUE_PROPOSITION.md → USE_CASES.md
Developer GETTING_STARTED.md ARCHITECTURE.md → FAQ.md
Architect ARCHITECTURE.md USE_CASES.md → Layer READMEs
Data Scientist VALUE_PROPOSITION.md ML Runner Docs
Curious VALUE_PROPOSITION.md SUMMARY.md

Complete Documentation

Overview and Value

Document What Contains Reading Time Level
VALUE_PROPOSITION.md What is chaM3Leon, advantages 10 min Easy
SUMMARY.md Executive summary 15 min Easy
README.md Technical project overview 8 min Medium

Guides and Tutorials

Document What Contains Reading Time Level
GETTING_STARTED.md Step-by-step tutorial, first project 30 min + practice Medium
ARCHITECTURE.md Architecture explained simply 20 min Medium
USE_CASES.md 8 detailed real use cases 40 min Medium

References

Document What Contains Type Level
FAQ.md 100+ questions and answers Reference Easy
CONFIG_LIST.md All available configurations Reference Technical
APPS_NAMING.md Naming conventions Reference Medium

Layer Documentation

Layer Language Document Focus
Batch Java/Spark chaM3Leon/batch/README.md Historical processing
Speed Java/Spark chaM3Leon/speed/README.md Real-time processing
Harvester Java/Spark chaM3Leon/harvester/README.md Data collection
Serving Java/Spring serving_chaM3Leon/README.md REST API
ML Runner Python PyChaM3Leon (GitHub) Machine Learning

Meta-Documentation

Document What Contains
docs/README.md Documentation index, learning paths

By Objective

I want to understand IF to use chaM3Leon

  1. VALUE_PROPOSITION.md - The value
  2. SUMMARY.md - ROI and costs
  3. USE_CASES.md - Possible applications
  4. FAQ.md - "Comparisons" section

I want to understand HOW it works

  1. ARCHITECTURE.md - Overview
  2. README.md - Implementation details
  3. Layer-specific READMEs - Deep dive

I want to START using it

  1. GETTING_STARTED.md - Complete tutorial
  2. CONFIG_LIST.md - Configurations
  3. APPS_NAMING.md - Conventions
  4. FAQ.md - Troubleshooting

I want to see EXAMPLES

  1. USE_CASES.md - 8 detailed cases
  2. GETTING_STARTED.md - Example project
  3. Layer READMEs - Specific examples
  4. YouTube Videos - Practical demos

I want to SOLVE a problem

  1. FAQ.md - 100+ Q&A
  2. GETTING_STARTED.md - Troubleshooting section
  3. GitHub Issues - Community

By Content Type

Concepts and Theory

Practice and Tutorials

Reference

Examples and Use Cases

By Industry/Sector

Find your sector in USE_CASES.md:

Sector Use Case Page
E-Commerce Sales monitoring, recommendations Case 1
Smart City IoT, traffic, air quality Case 2
Marketing Social media analytics, sentiment Case 3
Healthcare Patient monitoring, predictions Case 4
Manufacturing Predictive maintenance Case 5
Logistics Fleet management, optimization Case 6
Gaming Player analytics, anti-cheat Case 7
Agriculture Precision farming, smart irrigation Case 8

Video Content

Video Topic Duration Link
Framework Presentation General overview ~15 min YouTube
Batch & Speed Demo Practical example ~20 min YouTube

External Links

Repositories

Community

Technologies Used

File System Structure

chaM3Leon/
├── README.md - Main overview
├── VALUE_PROPOSITION.md - Framework value
├── SUMMARY.md - Executive summary
├── DOCUMENTATION_INDEX.md - This file
│
├── docs/ - Main documentation
│   ├── README.md - Documentation index
│   ├── GETTING_STARTED.md - Tutorial
│   ├── ARCHITECTURE.md - Architecture
│   ├── USE_CASES.md - Practical examples
│   ├── FAQ.md - Frequent questions
│   ├── CONFIG_LIST.md - Configurations
│   ├── APPS_NAMING.md - Naming conventions
│   └── *.png - Diagrams
│
├── chaM3Leon/ - Java Layers
│   ├── batch/README.md - Batch Layer
│   ├── speed/README.md - Speed Layer
│   ├── harvester/README.md - Harvester Layer
│   └── common/README.md - Common utilities
│
└── serving_chaM3Leon/ - Serving Layer
    └── README.md - Spring Boot API

Navigation Suggestions

First time here?

START → VALUE_PROPOSITION → SUMMARY → GETTING_STARTED

Want to implement immediately?

START → GETTING_STARTED → Layer README → CONFIG_LIST → GO!

Evaluating the framework?

START → SUMMARY → USE_CASES → FAQ (business section) → DECISION

Have a problem?

START → FAQ → GETTING_STARTED (troubleshooting) → GitHub Issues

Want to deep dive?

START → ARCHITECTURE → Layer READMEs → External docs → Expert!

Quick Search

Looking for information about...

Installation? → GETTING_STARTED.md

Configuration? → CONFIG_LIST.md

Spark? → ARCHITECTURE.md

Kafka? → ARCHITECTURE.md

Cassandra? → ARCHITECTURE.md

Machine Learning? → ML Runner

Performance? → FAQ.md

Security? → FAQ.md

Costs? → SUMMARY.md

ROI? → SUMMARY.md

Docker? → GETTING_STARTED.md

Examples? → USE_CASES.md

Mobile-Friendly Documentation

All documents are:

  • Markdown standard
  • Readable on GitHub mobile
  • Formatted for vertical reading
  • Working links on all devices

Translations

Available

  • Italian (Main)
  • English (Partial - Main README)

Planned

  • Spanish
  • French
  • German

Contributions for translations are welcome!

Documentation Statistics

  • Total documents: 15+
  • Total words: 25,000+
  • Code examples: 20+
  • Use cases: 8 detailed
  • FAQ: 100+ Q&A
  • External links: 50+
  • Diagrams: 5+

Recommended Learning Paths

Path 1: Business (2 hours)

  1. VALUE_PROPOSITION.md - 10 min
  2. SUMMARY.md - 15 min
  3. USE_CASES.md - 40 min (focus your sector)
  4. FAQ.md - 20 min (business sections)
  5. Presentation video - 15 min

Outcome: Informed decision on adoption

Path 2: Developer (1 day)

  1. VALUE_PROPOSITION.md - 10 min
  2. ARCHITECTURE.md - 20 min
  3. GETTING_STARTED.md - 2 hours (with practice)
  4. Specific Layer README - 30 min
  5. FAQ.md - 30 min
  6. First project - 3 hours

Outcome: First working project

Path 3: Architect (4 hours)

  1. SUMMARY.md - 15 min
  2. ARCHITECTURE.md - 30 min
  3. USE_CASES.md - 1 hour
  4. All Layer READMEs - 1 hour
  5. CONFIG_LIST.md - 30 min
  6. External docs (Spark, Kafka) - 1 hour

Outcome: Complete architectural design

Can't Find What You're Looking For?

  1. Use GitHub search (at the top of the repo page)
  2. Check FAQ.md - It's probably there
  3. Explore docs/README.md - Complete index
  4. Open GitHub Issue - Ask the community

Contribute to Documentation

Found an error? Want to add content?

  1. Fork the repository
  2. Edit the .md files
  3. Open a Pull Request

Guidelines: Write simply, use examples, add value!

Last Update

Date: October 27, 2025
Docs Version: 1.0.0
Framework Version: 2.0.0

Happy Learning!

← Back to Main README