Skip to content

chore(docs): add metadata and use core error - #41

Merged
mroczect merged 2 commits into
masterfrom
docs/chore/add-metadata-and-core-error
Sep 8, 2026
Merged

mroczect merged 2 commits into
masterfrom
docs/chore/add-metadata-and-core-error

Conversation

@mroczect

@mroczect mroczect commented Sep 8, 2026

Copy link
Copy Markdown
Owner

Summary

This PR adds standard Cargo package metadata to the docs crate and switches the main function's error type from std::error::Error to core::error::Error.

Motivation & Context

Adding metadata improves crate discoverability and documentation. Using core::error::Error aligns the docs application with the library's no_std-friendly error handling patterns and avoids unnecessary reliance on the standard library.

Detailed Changes

  • docs/Cargo.toml: Added description, license, repository, readme, keywords, and categories. Reformatted the librawssg dependency line for consistency.
  • docs/src/main.rs: Changed fn main() -> Result<(), Box<dyn std::error::Error>> to fn main() -> Result<(), Box<dyn core::error::Error>>.

Impact & Breaking Changes

No breaking changes identified.

Testing Recommendations

Run cargo run -p docs to ensure the documentation generator still builds and runs correctly.

Related Issues

None.

Add description, license, repository, readme, keywords, and categories to docs Cargo.toml. Align dependency formatting with workspace style.
Replace `std::error::Error` with `core::error::Error` for better no_std compatibility and consistency with other crates.
@mroczect
mroczect merged commit e95b855 into master Sep 8, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant