-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
component:coreCore library and error handlingCore library and error handlingepicLarge feature containing multiple storiesLarge feature containing multiple storiesmvpRequired for MVP releaseRequired for MVP releasepriority:criticalMust be done immediatelyMust be done immediately
Milestone
Description
PDFVEC-001
Goals
- Clean, ergonomic public API
- Comprehensive error types with context
- Zero unsafe code in public interface
- Full documentation with examples
Establish the core library structure including error handling, configuration, and the fundamental types that all other components build upon.
Acceptance Criteria
AC-1
- Given A new Rust project
- When pdfvec is added as a dependency
- Then It compiles with no warnings on stable Rust
AC-2
- Given Any error returned by pdfvec
- When The error is displayed
- Then It provides actionable context about what went wrong
AC-3
- Given The public API
- When cargo doc is run
- Then All public items have documentation with examples
Technical Context
Crates: thiserror, anyhow
Files:
src/lib.rssrc/error.rssrc/config.rs
Out of Scope
- Async API (future milestone)
- WASM support (future milestone)
Source: epics/00-core.json
Content Hash: 4dd478651bc19a51
Child Issues: PDFVEC-010, PDFVEC-011, PDFVEC-012
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
component:coreCore library and error handlingCore library and error handlingepicLarge feature containing multiple storiesLarge feature containing multiple storiesmvpRequired for MVP releaseRequired for MVP releasepriority:criticalMust be done immediatelyMust be done immediately