timeline-svg/SCOPE.md
tegwick bc06ad0f5b
All checks were successful
CI Smoke / host-smoke (push) Successful in 0s
CI Smoke / container-smoke (push) Successful in 2s
Complete State Hub bootstrap (TMLN-WP-0001); add TMLN-WP-0002
2026-07-08 15:07:17 +02:00

39 lines
1.5 KiB
Markdown

# SCOPE
> Lightweight boundary for agents and contributors.
## One-liner
TimelineSvg is a client-side, browser-based tool that generates multi-lane SVG timeline graphics from CSV data using an Inkscape-editable SVG template system with no backend or build pipeline.
## Core Idea
timeline-svg exists to provide the capability described in INTENT.md.
## In Scope
- Parsing CSV data into timeline items with configurable field mappings
- Rendering multi-lane SVG timelines via a template-v2 (DOM-based) architecture
- Supporting Inkscape/Illustrator/Figma-editable SVG templates with placeholder substitution
- Providing a browser UI (index.html/engine.js) for loading projects, previewing, and exporting SVGs
- In-browser inline file editing with modification tracking
- Vitest-based test suite covering generator, engine, and integration flows
- Distribution packaging (make dist/dist-zip) for offline/Windows deployment
## Out of Scope
- Server-side or backend processing (fully client-side by design)
- Build pipeline or bundler-based tooling
- Non-timeline visualization types (e.g., Gantt-specific scheduling logic beyond basic lanes/items)
- Authentication, multi-user collaboration, or persistence beyond local files
## Current State
- Template-v2 refactoring complete (40+ Vitest tests); Forgejo CI smoke workflow active.
- Bootstrap State Hub integration (TMLN-WP-0001) finished; next: distribution packaging (TMLN-WP-0002).
## Getting Oriented
- Start with: INTENT.md
- Agent instructions: AGENTS.md
- Workplans: workplans/