Skip to content

Add per-crate README for rsdm/adl2rsdm (release 0.5.4) - #4

Merged
physwkim merged 2 commits into
mainfrom
fix/rsdm-adl2rsdm-readme
Jul 16, 2026
Merged

physwkim merged 2 commits into
mainfrom
fix/rsdm-adl2rsdm-readme

Conversation

@physwkim

Copy link
Copy Markdown
Owner

A documentation-only patch release. No code, API, or behaviour changes.

The bug

rsplot sets readme = "README.md" and its crates.io page renders it. rsdm
and adl2rsdm had neither a readme field nor a README file, so their
per-crate crates.io pages showed nothing — the rendered-readme endpoint 403s
for rsdm/adl2rsdm 0.5.3 while rsplot's returns 200.

The fix

  • rsdm/README.md and adl2rsdm/README.md, each sourced from that crate's own
    crate-level docs (rsdm's PyDM-port layout and feature-gated backends;
    adl2rsdm's adl2pydm-mirrored parse → symbols → codegen → convert pipeline).
  • readme = "README.md" in both manifests, matching rsplot.
  • Verified both READMEs land in the packaged .crate.

crates.io bakes the README into each published version, so it surfaces only on
the next release, not retroactively on 0.5.3 — hence 0.5.4. All three crates
bump in lockstep (rsplot re-released unchanged).

Verification

cargo fmt --all --check, cargo clippy --workspace --all-targets -- -D warnings, cargo nextest run --workspace (2349/2349) and cargo test --doc --workspace all pass locally.

physwkim added 2 commits July 16, 2026 10:09
`rsplot` sets `readme = "README.md"` and its crates.io page renders it; `rsdm`
and `adl2rsdm` had neither a `readme` field nor a README file, so their
per-crate pages showed nothing (the rendered-readme endpoint 403s for 0.5.3).

Each gets a README sourced from its own crate-level docs — rsdm's PyDM-port
layout / feature-gated backends, adl2rsdm's adl2pydm-mirrored pipeline — plus
the `readme = "README.md"` field, matching rsplot. Verified both land in the
packaged `.crate`.

crates.io bakes the README per published version, so this surfaces only on the
next release, not retroactively on 0.5.3.
Documentation-only patch release: rsdm and adl2rsdm gained the README that
crates.io renders per crate (they shipped without one; rsplot's already
rendered). crates.io bakes the README into each published version, so surfacing
it required a new release rather than an edit to 0.5.3.

No code or behaviour changes. All three crates bump in lockstep as always.
@physwkim
physwkim merged commit 3036b9e into main Jul 16, 2026
4 checks passed
@physwkim
physwkim deleted the fix/rsdm-adl2rsdm-readme branch July 16, 2026 01:33
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