Skip to content

docs(links): repair package documentation targets - #2208

Merged
josecelano merged 4 commits into
torrust:developfrom
josecelano:2185-repair-docsrs-package-links
Sep 14, 2026
Merged

josecelano merged 4 commits into
torrust:developfrom
josecelano:2185-repair-docsrs-package-links

Conversation

@josecelano

Copy link
Copy Markdown
Member

Summary

  • repairs the 14 C3 package README links that pointed to unavailable individual docs.rs crate pages
  • points each affected README to the shared tracker docs.rs target resolved from Cargo metadata
  • records authoritative replacement-target evidence and independent review

Validation

  • linter all
  • Cargo metadata verification for all 14 affected packages
  • HTTP 200 verification of https://docs.rs/crate/torrust-tracker/
  • ./contrib/dev-tools/git/hooks/pre-commit.sh
  • ./contrib/dev-tools/git/hooks/pre-push.sh

Hosted Verification

After merge, manually dispatch the upstream External Link Check and confirm the 14 replaced individual docs.rs URLs are absent while unrelated failures remain visible and the report artifact uploads.

Related to #2185
Related to #2003

Copilot AI lite review requested due to automatic review settings September 11, 2026 16:54
@josecelano josecelano self-assigned this Sep 11, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Pull request overview

Repairs stale docs.rs links across workspace package READMEs by redirecting them to a shared, metadata-derived documentation target, and records evidence/review updates for the external link check triage effort.

Changes:

  • Updated 14 package README.md files to use the shared https://docs.rs/crate/torrust-tracker/ documentation URL.
  • Updated baseline triage documentation to mark C3 as repaired and document verification details.
  • Added an independent review entry and updated issue/task tracking status for the remediation slice.

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
packages/udp-server/README.md Updates crate documentation link to shared docs.rs target.
packages/udp-protocol/README.md Updates crate documentation link to shared docs.rs target.
packages/udp-core/README.md Updates crate documentation link to shared docs.rs target.
packages/tracker-core/README.md Updates crate documentation link to shared docs.rs target.
packages/rest-api-runtime-adapter/README.md Updates crate documentation link to shared docs.rs target.
packages/rest-api-protocol/README.md Updates crate documentation link to shared docs.rs target.
packages/rest-api-application/README.md Updates crate documentation link to shared docs.rs target.
packages/http-protocol/README.md Updates crate documentation link to shared docs.rs target.
packages/http-core/README.md Updates crate documentation link to shared docs.rs target.
packages/events/README.md Updates crate documentation link to shared docs.rs target.
packages/axum-server/README.md Updates crate documentation link to shared docs.rs target.
packages/axum-rest-api-server/README.md Updates crate documentation link to shared docs.rs target.
packages/axum-http-server/README.md Updates crate documentation link to shared docs.rs target.
packages/axum-health-check-api-server/README.md Updates crate documentation link to shared docs.rs target.
docs/issues/open/2185-2003-triage-advisory-external-link-check-findings/external-link-baseline.md Marks C3 as repaired and adds verification notes about the replacement target.
docs/issues/open/2185-2003-triage-advisory-external-link-check-findings/agent-review-reports.md Adds a task reviewer entry detailing scope, evidence, and follow-ups.
docs/issues/open/2185-2003-triage-advisory-external-link-check-findings/ISSUE.md Updates last-updated timestamp, task status, and acceptance criteria notes for C3.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread packages/udp-server/README.md Outdated
josecelano added a commit to josecelano/torrust-tracker that referenced this pull request Sep 11, 2026
@josecelano
josecelano force-pushed the 2185-repair-docsrs-package-links branch from b560a9e to ae6c746 Compare September 14, 2026 09:23
@josecelano

Copy link
Copy Markdown
Member Author

ACK ae6c746

@josecelano
josecelano merged commit 952911a into torrust:develop Sep 14, 2026
10 checks passed
josecelano added a commit that referenced this pull request Sep 14, 2026
f258542 docs(review): document PR #2211 Copilot suggestions audit (Jose Celano)
ccea3c1 docs(review): clarify deferred link triage (Jose Celano)
984b025 docs(review): complete C3 acceptance evidence (Jose Celano)
2d6a59b docs(links): record C3 hosted verification (Jose Celano)

Pull request description:

  Records the independently reviewed hosted verification for the C3 docs.rs reference repair after PR #2208 merged.

  ## Evidence

  - External Link Check [run 34829466145](https://github.com/torrust/torrust-tracker/actions/runs/34829466145) ran on merged `develop` revision `952911af2321e848ac95ad183e8e8b96d8fd354a`.
  - The advisory check failed visibly with 31 unrelated errors; the report artifact uploaded successfully and is retained through 2026-09-28.
  - The report contains none of the 14 retired package-specific docs.rs URLs and retains representative unrelated failures.
  - The issue-local independent review records the initial count correction and confirms C3 evidence is complete while the remaining categories stay pending.

  Related to #2185

ACKs for top commit:
  josecelano:
    ACK f258542

Tree-SHA512: d442e386e25cf137a6ec19be66a35bf3939b23856ce29d3b23f9fba4bf57e1143a346e59b52b0114e6fd8c5b4284d6193b172c5ae3b667f6806348e665f13d00
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.

2 participants