lutaml 0.9.43 → 0.10.0

data/docs/_references/index.adoc

@@ -0,0 +1,197 @@
+= Reference
+:nav_order: 4
+:has_children: true
+
+== Overview
+
+This section provides detailed technical specifications, API documentation, and configuration schemas for LutaML.
+
+== Command-Line Interface
+
+=== link:cli/commands[Complete Command Reference]
+
+Comprehensive reference for all CLI commands, options, and arguments.
+
+=== Individual Commands
+
+* link:cli/build[`lutaml uml build`] - Build LUR packages
+* link:cli/search[`lutaml uml search`] - Search models
+* link:cli/export[`lutaml uml export`] - Export data
+* link:cli/ls[`lutaml uml ls`] - List elements
+* link:cli/tree[`lutaml uml tree`] - Show hierarchy
+* link:cli/stats[`lutaml uml stats`] - Statistics
+* link:cli/docs[`lutaml uml docs`] - Generate docs
+* link:cli/serve[`lutaml uml serve`] - Start server
+
+== API Documentation
+
+=== Core APIs
+
+==== link:api/repository[Repository API]
+
+Complete API reference for `Lutaml::UmlRepository::Repository` class.
+
+**Topics:**
+
+* Creating repositories
+* Querying methods
+* Index management
+* Statistics calculation
+
+==== link:api/parsers[Parser APIs]
+
+Reference for all parser interfaces and implementations.
+
+**Topics:**
+
+* Unified parser interface
+* Format-specific parsers
+* Parser options
+* Error handling
+
+==== link:api/presenters[Presenter APIs]
+
+Documentation for element presentation and formatting.
+
+**Topics:**
+
+* Presenter factory
+* Element presenters
+* Output formats
+* Customization
+
+=== Query DSL
+
+Complete reference for the query DSL syntax and methods.
+
+=== Model Classes
+
+* `Lutaml::Uml::Document`
+* `Lutaml::Uml::Package`
+* `Lutaml::Uml::Class`
+* `Lutaml::Uml::Attribute`
+* `Lutaml::Uml::Association`
+* `Lutaml::Uml::Diagram`
+
+== File Formats
+
+=== link:formats/qea-structure[QEA File Format]
+
+Complete specification of Enterprise Architect's QEA (SQLite) database format.
+
+**Topics:**
+
+* Database schema
+* Table relationships
+* Data types
+* Supported EA versions
+
+=== link:formats/lur-format[LUR Package Format]
+
+Specification of LutaML's compressed repository format.
+
+**Topics:**
+
+* Package structure
+* Compression
+* Versioning
+* Metadata
+
+=== link:formats/lutaml-syntax[LutaML Syntax]
+
+Complete syntax reference for LutaML's native DSL.
+
+**Topics:**
+
+* Diagram syntax
+* Class definitions
+* Associations
+* Attributes and operations
+
+=== XMI Support
+
+OMG XMI format compatibility and extensions.
+
+=== EXPRESS Support
+
+ISO 10303-11 EXPRESS schema support via Expressir.
+
+== Configuration
+
+=== link:configuration/diagram-styles[Diagram Styling Configuration]
+
+Complete YAML schema for diagram style configuration.
+
+**Topics:**
+
+* Stereotype styling
+* Package patterns
+* Connector types
+* Priority rules
+
+=== link:configuration/package-metadata[Package Metadata Configuration]
+
+YAML schema for package metadata including XML namespaces.
+
+**Topics:**
+
+* Metadata keys
+* Wildcard patterns
+* Precedence rules
+* Integration
+
+=== Static Site Configuration
+
+YAML configuration for SPA documentation generation.
+
+=== Repository Configuration
+
+LUR repository settings and options.
+
+== Data Models
+
+=== UML Metamodel
+
+Complete UML metamodel implementation in Ruby.
+
+=== EA Model Mapping
+
+How Enterprise Architect concepts map to UML.
+
+=== Type System
+
+Type definitions and compatibility across formats.
+
+== Error Codes
+
+Reference for all error codes and messages.
+
+== Performance
+
+=== Benchmarks
+
+Performance characteristics and benchmarks for various operations.
+
+=== Optimization Guidelines
+
+Best practices for optimal performance.
+
+== Compatibility
+
+=== Ruby Versions
+
+Supported Ruby versions and compatibility notes.
+
+=== EA Versions
+
+Enterprise Architect version compatibility.
+
+=== Platform Support
+
+Operating system and platform compatibility.
+
+== Related Sections
+
+* link:../pages[Core Topics] - Fundamental concepts
+* link:../tutorials[Tutorials] - Step-by-step learning
+* link:../guides[Guides] - Task-oriented documentation

data/docs/_tutorials/index.adoc

@@ -0,0 +1,109 @@
+---
+title: Tutorials
+nav_order: 2
+has_children: true
+---
+= Tutorials
+
+== Overview
+
+This section provides step-by-step learning paths to help you accomplish specific tasks with LutaML. Each tutorial walks you through a complete workflow from start to finish.
+
+== Available Tutorials
+
+=== link:/tutorials/getting-started[Getting Started with LutaML]
+
+Your first steps with LutaML. Learn how to install, parse your first model file, and explore basic functionality.
+
+**What you'll learn:**
+
+* Installing LutaML
+* Parsing XMI and QEA files
+* Understanding the `Lutaml::Parser` interface
+* Basic model exploration
+
+**Time:** 15 minutes
+
+---
+
+=== link:/tutorials/first-lur-package[Building Your First LUR Package]
+
+Create a LutaML UML Repository (LUR) package from an XMI or QEA file for fast loading and querying.
+
+**What you'll learn:**
+
+* Converting XMI/QEA to LUR format
+* Understanding LUR package structure
+* Loading and querying LUR packages
+* Performance benefits
+
+**Time:** 20 minutes
+
+---
+
+=== link:/tutorials/generating-diagrams[Generating Diagrams]
+
+Generate pixel-perfect SVG diagrams from Enterprise Architect models with full styling support.
+
+**What you'll learn:**
+
+* Loading diagrams from QEA files
+* Basic diagram generation
+* Customizing colors and styles
+* Exporting diagrams
+
+**Time:** 25 minutes
+
+---
+
+=== link:/tutorials/documentation-site[Creating a Documentation Site]
+
+Build a complete SPA documentation website from your UML model with search and navigation.
+
+**What you'll learn:**
+
+* Using the `build-spa` command
+* Understanding output modes
+* Customizing the site
+* Deploying documentation
+
+**Time:** 20 minutes
+
+---
+
+=== link:/tutorials/querying-models[Searching and Querying Models]
+
+Master the query DSL and search capabilities to find exactly what you need in large models.
+
+**What you'll learn:**
+
+* Full-text search
+* Using the query DSL
+* Filtering by stereotype
+* Advanced queries
+
+**Time:** 30 minutes
+
+== Prerequisites
+
+Most tutorials assume you have:
+
+* Ruby 2.7+ installed
+* Basic command-line knowledge
+* LutaML installed (see link:/installation[Installation Guide])
+
+== Tutorial Format
+
+Each tutorial follows this structure:
+
+1. **Purpose** - What you'll accomplish
+2. **Prerequisites** - What you need before starting
+3. **Steps** - Detailed walkthrough with code examples
+4. **Verification** - How to confirm success
+5. **Next Steps** - Where to go from here
+
+== Related Sections
+
+* link:/pages[Core Topics] - Fundamental concepts
+* link:/guides[Guides] - Task-oriented how-to documentation
+* link:/references[Reference] - Detailed specifications

data/docs/index.adoc

@@ -0,0 +1,64 @@
+---
+title: Home
+nav_order: 1
+---
+= Home
+:page-layout: home
+:page-title: LutaML Documentation Home
+
+== Welcome to LutaML
+
+LutaML is a universal Ruby library and CLI for accessing, parsing, and manipulating data models across multiple modeling languages.
+
+=== What LutaML Does
+
+LutaML provides a unified interface for:
+
+* **UML Model Access**: Parse Enterprise Architect (EA) models from QEA (SQLite) and XMI formats
+* **EXPRESS Support**: Handle ISO 10303-11 EXPRESS schemas used in industrial standards
+* **Diagram Generation**: Generate pixel-perfect SVG diagrams from EA models with full styling
+* **Model Transformation**: Convert between different modeling formats
+* **Repository Management**: Store and query models in compressed LUR (LutaML UML Repository) format
+* **Documentation Generation**: Create browsable SPA (Single Page Application) sites from models
+
+=== Getting Started
+
+New to LutaML? Start here:
+
+* link:/installation[Installation Guide] - Get LutaML up and running
+* link:/tutorials/getting-started[Quick Start Tutorial] - Your first steps with LutaML
+* link:/overview[What is LutaML?] - Learn about the architecture and capabilities
+
+=== Documentation Sections
+
+==== link:/core[Core Topics]
+
+Fundamental concepts and essential information about LutaML's architecture, components, and capabilities.
+
+==== link:/tutorials[Tutorials]
+
+Step-by-step learning paths to help you accomplish specific tasks with LutaML.
+
+==== link:/guides[Guides]
+
+Task-oriented how-to documentation for common workflows and operations.
+
+==== link:/references[Reference]
+
+Detailed technical specifications, API documentation, and configuration schemas.
+
+=== Quick Links
+
+* https://github.com/lutaml/lutaml[GitHub Repository]
+* https://rubygems.org/gems/lutaml[RubyGems Package]
+* link:/installation[Installation]
+* link:/references/cli/commands[CLI Reference]
+* link:/references/api/repository[API Reference]
+
+=== Community
+
+LutaML is open source and maintained by https://www.ribose.com[Ribose].
+
+* Report issues: https://github.com/lutaml/lutaml/issues
+* Contribute: https://github.com/lutaml/lutaml/blob/main/CONTRIBUTING.md
+* License: https://github.com/lutaml/lutaml/blob/main/LICENSE[BSD-3-Clause]

data/docs/lychee.toml

@@ -0,0 +1,83 @@
+# Lychee link checker configuration for LutaML documentation
+
+# Cache results for 1 day to speed up repeated checks
+cache = true
+
+# Maximum number of concurrent requests
+max_concurrency = 10
+
+# Request timeout in seconds
+timeout = 30
+
+# Maximum number of retries per link
+max_retries = 3
+
+# Follow redirects
+follow_redirects = true
+
+# Maximum redirect depth
+max_redirects = 5
+
+# Accept status codes
+accept = [
+    200,  # OK
+    203,  # Non-Authoritative Information
+    204,  # No Content
+    206,  # Partial Content
+    429,  # Too Many Requests (we'll retry)
+]
+
+# Exclude patterns (glob format)
+exclude = [
+    # Exclude localhost links
+    'http://localhost*',
+    'http://127.0.0.1*',
+
+    # Exclude example domains
+    'http://example.com*',
+    'https://example.com*',
+
+    # Exclude GitHub edit links (they may 404 for non-contributors)
+    'https://github.com/*/edit/*',
+
+    # Exclude potential rate-limited APIs
+    'https://api.github.com/*',
+]
+
+# Include patterns - check these file types
+include = [
+    '**/*.html',
+    '**/*.md',
+    '**/*.adoc',
+]
+
+# HTTP headers to send with requests
+[headers]
+# Set user agent
+User-Agent = "Mozilla/5.0 (compatible; Lychee/0.13.0; +https://github.com/lycheeverse/lychee)"
+
+# GitHub API token (if available in environment)
+# Authorization = "Bearer ${GITHUB_TOKEN}"
+
+# Verbose output
+verbose = true
+
+# Don't show progress bar in CI
+no_progress = true
+
+# Output format
+format = "markdown"
+
+# Exclude paths from file system checks
+exclude_path = [
+    ".git/",
+    "_site/",
+    "node_modules/",
+    "vendor/",
+]
+
+# Scheme to use when checking local files
+scheme = "https"
+
+# Base URL for relative links
+# base = "https://lutaml.github.io/lutaml"