From 2d4200843627ea72e063548a12803dcc33dd8073 Mon Sep 17 00:00:00 2001 From: GF Date: Wed, 15 Jul 2026 22:32:29 -0400 Subject: [PATCH] Improve Rust JPEG 2000 discovery --- Cargo.toml | 2 +- README.md | 4 +-- crates/j2k/Cargo.toml | 3 +- crates/j2k/README.md | 3 +- crates/j2k/src/lib.rs | 2 +- docs/index.html | 14 ++++---- docs/rust-jpeg2000-codec/index.html | 20 +++++------ docs/sitemap.xml | 4 +-- .../repo_lint_support/public_docs_policy.rs | 34 +++++++++++++++++++ 9 files changed, 61 insertions(+), 25 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 5dbc821a..0f0f0eca 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -33,7 +33,7 @@ edition = "2021" rust-version = "1.96" license = "MIT OR Apache-2.0" repository = "https://github.com/frames-sg/j2k" -homepage = "https://github.com/frames-sg/j2k" +homepage = "https://frames-sg.github.io/j2k/rust-jpeg2000-codec/" keywords = ["jpeg", "jpeg2000", "htj2k", "gpu", "transcode"] categories = ["multimedia::images", "multimedia::encoding", "compression"] diff --git a/README.md b/README.md index b239d569..e24e2627 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# J2K +# J2K — Pure-Rust JPEG 2000 and HTJ2K Codec [![crates.io](https://img.shields.io/crates/v/j2k.svg)](https://crates.io/crates/j2k) [![docs.rs](https://img.shields.io/docsrs/j2k)](https://docs.rs/j2k) @@ -6,7 +6,7 @@ [![downloads](https://img.shields.io/crates/d/j2k.svg)](https://crates.io/crates/j2k) [![license](https://img.shields.io/crates/l/j2k.svg)](#license) -**Docs & guides:** +**Docs & guides:** [Pure-Rust JPEG 2000 codec documentation](https://frames-sg.github.io/j2k/rust-jpeg2000-codec/) **Release status:** `0.7.3` is published and security-supported. See the [release notes](CHANGELOG.md) and [release policy](docs/release.md). diff --git a/crates/j2k/Cargo.toml b/crates/j2k/Cargo.toml index 14792b60..72bd24c2 100644 --- a/crates/j2k/Cargo.toml +++ b/crates/j2k/Cargo.toml @@ -1,11 +1,12 @@ [package] name = "j2k" -description = "Safe public JPEG 2000 and HTJ2K CPU codec APIs with optional CUDA and Metal adapters" +description = "Pure-Rust JPEG 2000 and HTJ2K codec APIs with optional CUDA and Metal adapters" version.workspace = true edition.workspace = true rust-version.workspace = true license.workspace = true repository.workspace = true +homepage.workspace = true keywords.workspace = true categories.workspace = true readme = "README.md" diff --git a/crates/j2k/README.md b/crates/j2k/README.md index 5127b0be..297b02f1 100644 --- a/crates/j2k/README.md +++ b/crates/j2k/README.md @@ -1,4 +1,4 @@ -# j2k +# j2k — Pure-Rust JPEG 2000 and HTJ2K Codec JPEG 2000 Part 1 and HTJ2K Part 15 public CPU codec facade for J2K. @@ -38,5 +38,6 @@ callers that need fail-closed validation should construct native images with ## Links - API docs: +- [Pure-Rust JPEG 2000 codec documentation](https://frames-sg.github.io/j2k/rust-jpeg2000-codec/) - Repository: - Support policy: diff --git a/crates/j2k/src/lib.rs b/crates/j2k/src/lib.rs index 2721131c..319b5bb8 100644 --- a/crates/j2k/src/lib.rs +++ b/crates/j2k/src/lib.rs @@ -1,6 +1,6 @@ // SPDX-License-Identifier: MIT OR Apache-2.0 -//! Public JPEG 2000 Part 1 and HTJ2K Part 15 CPU codec facade. +//! Pure-Rust JPEG 2000 Part 1 and HTJ2K Part 15 codec APIs. //! //! This crate provides inspection, decode, encode, lossless J2K-to-HTJ2K //! recoding, still-image container wrapping, and device-decode planning. Shared diff --git a/docs/index.html b/docs/index.html index 2377cd42..56835d49 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,10 +3,10 @@ - J2K: Rust JPEG 2000 / HTJ2K Codec + J2K Codec Project — Documentation and Packages - + @@ -14,7 +14,7 @@ - + @@ -25,7 +25,7 @@ "@context": "https://schema.org", "@type": "SoftwareSourceCode", "name": "J2K", - "headline": "J2K: Rust JPEG 2000 / HTJ2K Codec", + "headline": "J2K Codec Project — Documentation and Packages", "codeRepository": "https://github.com/frames-sg/j2k", "programmingLanguage": "Rust", "license": "https://www.apache.org/licenses/LICENSE-2.0", @@ -39,7 +39,7 @@
J2K