Skip to main content

Crate design

Crate design 

Source
Expand description

Design documentation library for Oxur

This library provides types and utilities for managing design documents in the Oxur project.

Re-exports§

pub use doc::add_missing_headers;
pub use doc::add_number_prefix;
pub use doc::build_yaml_frontmatter;
pub use doc::ensure_valid_headers;
pub use doc::extract_number_from_filename;
pub use doc::extract_title_from_content;
pub use doc::has_frontmatter;
pub use doc::has_number_prefix;
pub use doc::has_placeholder_values;
pub use doc::is_in_project_dir;
pub use doc::is_in_state_dir;
pub use doc::move_to_project;
pub use doc::move_to_state_dir;
pub use doc::state_from_directory;
pub use doc::sync_state_with_directory;
pub use doc::DesignDoc;
pub use doc::DocError;
pub use doc::DocMetadata;
pub use doc::DocState;
pub use index::DocumentIndex;

Modules§

config
constants
Constants used throughout the design crate
doc
Design document types and parsing
errors
Error handling utilities
extract
Metadata extraction from document content
filename
Filename sanitization and normalization
git
Git integration for design documents
index
Document index management
index_sync
Index synchronization module
normalize
Markdown content normalization
prompt
Interactive prompting for user input
state
State management and persistence
theme
Color theme for consistent output

Structs§

Error
Re-export common error types The Error type, a wrapper around a dynamic error type.

Type Aliases§

Result
Re-export common error types Result<T, Error>