Skip to content

docs: fix two broken docs-site links in the README#132

Merged
powersemmi merged 1 commit into
mainfrom
docs/readme-links
Jul 3, 2026
Merged

docs: fix two broken docs-site links in the README#132
powersemmi merged 1 commit into
mainfrom
docs/readme-links

Conversation

@powersemmi

Copy link
Copy Markdown
Owner

Description

Two docs-site links in the README 404: the quickstart link under Run it and the testing-guide link under Testing the service both pointed at subpaths without the version segment. The site is published with mike, where latest is a real directory, so subpaths only resolve under /latest/ (the root serves the latest index, but subpaths are not aliased at the root). The rest of the README already uses the /latest/ form for its docs links; these two were missed.

Repoint both to the /latest/ form:

  • …/ruststream/getting-started/quickstart/ -> …/ruststream/latest/getting-started/quickstart/
  • …/ruststream/guides/testing/ -> …/ruststream/latest/guides/testing/

Both now return 200.

Docs-only; no code change.

Type of change

  • Documentation (typos, code examples, or any documentation updates)
  • Bug fix (a non-breaking change that resolves an issue)
  • New feature (a non-breaking change that adds functionality)
  • Breaking change (removing or renaming public API, changing a signature, tightening bounds, or
    raising the MSRV - a minor version bump pre-1.0)
  • This change requires a documentation update

Checklist

  • My code follows the project's style guidelines (just check passes: rustfmt, clippy, and
    cargo check with all features and with --no-default-features)
  • I have performed a self-review of my own code
  • I have made the necessary changes to the documentation (rustdoc and/or the docs site)
  • My changes generate no new warnings (clippy runs with -D warnings)
  • I have added tests that validate my fix or new feature
  • New and existing tests pass locally (just test)
  • Public items carry a compiling # Examples doctest, and user-facing changes are reflected in
    examples/ where applicable

The quickstart and testing-guide links pointed at docs-site subpaths
without the version segment, which 404 under the mike-published site
(latest is a real directory, so subpaths resolve under /latest/).
Repoint them to the /latest/ form that the rest of the README already
uses.

Docs-only; no code change.
@powersemmi powersemmi self-assigned this Jul 3, 2026
@powersemmi powersemmi merged commit 6e3916a into main Jul 3, 2026
11 checks passed
@powersemmi powersemmi added the documentation Improvements or additions to documentation label Jul 3, 2026
@powersemmi powersemmi deleted the docs/readme-links branch July 3, 2026 17:21
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.

1 participant