Skip to content

fix(docs): replace dead privacy.md link with GitHub URL#7641

Merged
JohnMcLear merged 1 commit intodevelopfrom
fix/docs-privacy-dead-link
May 1, 2026
Merged

fix(docs): replace dead privacy.md link with GitHub URL#7641
JohnMcLear merged 1 commit intodevelopfrom
fix/docs-privacy-dead-link

Conversation

@JohnMcLear
Copy link
Copy Markdown
Member

Summary

  • PR feat(gdpr): pad deletion controls (PR1 of #6701) #7546 added a relative link in doc/privacy.md to ../docs/superpowers/specs/2026-04-18-gdpr-pr1-deletion-controls-design.md. That spec file lives outside vitepress's doc/ source root, so VitePress flags it as a dead link and the Deploy Docs to GitHub Pages workflow on develop fails:

    Found dead link ./../docs/superpowers/specs/2026-04-18-gdpr-pr1-deletion-controls-design in file doc/privacy.mdError: 1 dead link(s) found.

  • Repoint the link at the file on GitHub so the published site resolves it and readers can still find the spec.
  • Follows up fix(docs): add oxc-minify so vitepress builds with rolldown-vite #7640 (the docs build now reaches the dead-link check thanks to that fix).

Test plan

  • pnpm run docs:build succeeds locally (build complete in 2.29s)
  • CI: Deploy Docs to GitHub Pages turns green on develop after merge

🤖 Generated with Claude Code

PR #7546 added a relative link in `doc/privacy.md` pointing to
`../docs/superpowers/specs/2026-04-18-gdpr-pr1-deletion-controls-design.md`,
which lives outside vitepress's `doc/` source root. VitePress reports
it as a dead link and the docs deploy on develop fails:

    (!) Found dead link
        ./../docs/superpowers/specs/2026-04-18-gdpr-pr1-deletion-controls-design
        in file /home/runner/work/etherpad/etherpad/doc/privacy.md
    Error: 1 dead link(s) found.

Point the link at the file on GitHub instead so the published site
resolves it and readers can still find the spec.

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
@qodo-code-review
Copy link
Copy Markdown

ⓘ You've reached your Qodo monthly free-tier limit. Reviews pause until next month — upgrade your plan to continue now, or link your paid account if you already have one.

@qodo-free-for-open-source-projects
Copy link
Copy Markdown

Review Summary by Qodo

Fix dead link in privacy.md by pointing to GitHub URL

🐞 Bug fix 📝 Documentation

Grey Divider

Walkthroughs

Description
• Replace relative link to spec file with GitHub URL
• Resolves VitePress dead link detection failure
• Enables docs deployment workflow to succeed
Diagram
flowchart LR
  A["Relative link<br/>../docs/superpowers/specs/..."] -->|"Replace with"| B["GitHub URL<br/>github.com/ether/etherpad/blob/develop/..."]
  B -->|"Result"| C["VitePress validation passes<br/>Docs deploy succeeds"]
Loading

Grey Divider

File Changes

1. doc/privacy.md 🐞 Bug fix +1/-1

Replace dead relative link with GitHub URL

• Changed relative link to spec file outside VitePress source root to absolute GitHub URL
• Link now points to
 https://github.com/ether/etherpad/blob/develop/docs/superpowers/specs/2026-04-18-gdpr-pr1-deletion-controls-design.md
• Resolves dead link detection error in docs build workflow

doc/privacy.md


Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects
Copy link
Copy Markdown

qodo-free-for-open-source-projects Bot commented May 1, 2026

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (1)

Grey Divider


Remediation recommended

1. Hardcoded https://github.com link 📘 Rule violation ⚙ Maintainability
Description
The updated docs link uses a hardcoded https:// URL instead of a protocol-independent URL, which
violates the project standard for protocol-independent references. This can cause inconsistent
behavior in environments where protocol should be inherited.
Code

doc/privacy.md[59]

+[`docs/superpowers/specs/2026-04-18-gdpr-pr1-deletion-controls-design.md`](https://github.com/ether/etherpad/blob/develop/docs/superpowers/specs/2026-04-18-gdpr-pr1-deletion-controls-design.md)
Evidence
PR Compliance ID 9 requires protocol-independent URLs where applicable; the new link introduced in
doc/privacy.md hardcodes the https:// scheme.

doc/privacy.md[59-59]
Best Practice: Repository guidelines

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`doc/privacy.md` introduces a hardcoded `https://` URL, but the compliance checklist requires protocol-independent URLs where applicable.

## Issue Context
The link was updated to point to a GitHub-hosted file; it can be written without an explicit scheme.

## Fix Focus Areas
- doc/privacy.md[59-59]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

@JohnMcLear JohnMcLear merged commit b47fcd8 into develop May 1, 2026
1 check passed
@JohnMcLear JohnMcLear deleted the fix/docs-privacy-dead-link branch May 1, 2026 12:58
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