Skip to content

Opt heed crates into multi-target docs.rs builds#364

Merged
Kerollmops merged 1 commit into
meilisearch:mainfrom
MukundaKatta:docs-rs-metadata-targets
Apr 22, 2026
Merged

Opt heed crates into multi-target docs.rs builds#364
Kerollmops merged 1 commit into
meilisearch:mainfrom
MukundaKatta:docs-rs-metadata-targets

Conversation

@MukundaKatta

Copy link
Copy Markdown
Contributor

Summary

  • docs.rs now only builds on `x86_64-unknown-linux-gnu` by default (see the April 2026 announcement). heed and heed3 expose Windows- and macOS/iOS-specific items (e.g. the `posix-sem` feature, `url`-based Windows path handling), so the rendered docs would silently lose them on every release.
  • Adds a `[package.metadata.docs.rs]` block to `heed`, `heed3`, `lmdb-master-sys`, and `lmdb-master3-sys` opting into the tier-1 targets the crates actually support: x86_64 and aarch64 Linux, x86_64 and aarch64 macOS, and x86_64 Windows.
  • `heed` and `heed3` additionally request `all-features = true` so the optional serde / encryption items keep appearing in the API reference.

Closes #363.

Test plan

  • `cargo metadata --no-deps --format-version 1 | jq '.packages[] | select(.name=="heed") | .metadata'` reflects the new targets list.
  • Verify on docs.rs after the next release that the Windows-only / macOS-only items render.

🤖 Generated with Claude Code

docs.rs now defaults to building documentation only on
`x86_64-unknown-linux-gnu`. heed and heed3 expose Windows-specific and
macOS/iOS-specific items (posix-sem feature, url-based path handling on
Windows, etc.), so the rendered docs would lose those items on every
release.

Add a `[package.metadata.docs.rs]` section to heed, heed3, lmdb-master-sys,
and lmdb-master3-sys opting into the five tier-1 targets the crates
actually support: x86_64 and aarch64 Linux, x86_64 and aarch64 macOS, and
x86_64 Windows. The heed and heed3 sections additionally request
`all-features = true` so the optional serde/encryption items keep showing
up in the API reference.

See <https://blog.rust-lang.org/2026/04/04/docsrs-only-default-targets/>.

Closes meilisearch#363

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@Kerollmops Kerollmops enabled auto-merge April 22, 2026 13:13
@Kerollmops Kerollmops added the documentation Improvements or additions to documentation label Apr 22, 2026

@Kerollmops Kerollmops left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Looks good to me. Merging!

@Kerollmops Kerollmops added this pull request to the merge queue Apr 22, 2026
Merged via the queue into meilisearch:main with commit 1ac37ea Apr 22, 2026
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Specify more targets for docs.rs to build and expose heed

2 participants