How a-gubskiy/x.web.sitemap works
Main Components
a. Core Components:
• Sitemap Generator System
• Sitemap Index Generator System
• Serialization Layer
• File System Interface
• Domain Models
b. External Interfaces:
• Client Application Integration Point
• File System Output
┌─ Client Integration Layer ─────────────────────┐
• Public APIs (ISitemap, Generators) │
• ┬───────────────────────────┘
• ↓
┌─ Domain Layer ────────────────────────────────┐
• Models (Url, Image, SitemapInfo) │
• Enums (ChangeFrequency) │
• ┬───────────────────────────┘
• ↓
┌─ Core Services Layer ──────────────────────────┐
• SitemapGenerator │
• SitemapIndexGenerator │
• ┬───────────────────────────┘
• ↓
┌─ Serialization Layer ─────────────────────────┐
• SitemapSerializer │
• SitemapIndexSerializer │
• ┬───────────────────────────┘
• ↓
┌─ Infrastructure Layer ────────────────────────┐
• FileSystemWrapper │
• XML Management │
• ┘
Important Relationships to Highlight
• How SitemapGenerator depends on SitemapSerializer
• Relationship between Sitemap and SitemapIndex
• Demonstrate how FileSystemWrapper abstracts file system operations
• Extension methods enhancing core functionality
Key Architectural Patterns to Emphasize
• Interface-based design (ISitemap)
• Separation of concerns (Generators vs. Serializers)
• Extension-based functionality
• Factory pattern for sitemap generation
Implementation Details
• Key public methods
• Important properties
• Relationships with other components
For example:
┌─ SitemapGenerator ─────────┐
• GenerateSitemaps() │
• SaveToDirectory() │
• ┬───────────────┘
• ↓
┌─ SitemapSerializer ───────┐
• Serialize() │
• Deserialize() │
• ┘
Integration Points
How the library integrates with:
• File system for output
• XML manipulation
• Client applications
Remember to maintain a balance between detail and clarity, focusing on the core functionality of sitemap generation and management while showing the extensibility points and integration capabilities of the library.