Skip to content

docs: restore Duplicate Encryption Keys page to the public site#3534

Merged
Yeraze merged 2 commits into
mainfrom
fix/restore-security-duplicate-keys-page
Jun 18, 2026
Merged

docs: restore Duplicate Encryption Keys page to the public site#3534
Yeraze merged 2 commits into
mainfrom
fix/restore-security-duplicate-keys-page

Conversation

@Yeraze

@Yeraze Yeraze commented Jun 18, 2026

Copy link
Copy Markdown
Owner

Problem

https://meshmonitor.org/security-duplicate-keys returns 404. That URL is the target of a public short link (https://bit.ly/4okVACV → 301 → /security-duplicate-keys) that affected users are directed to — the page itself opens with "If you were sent here, it's because your Node is vulnerable to security issues."

Cause

PR #3138 (docs reorg) moved docs/security-duplicate-keys.mddocs/internal/dev-notes/security-duplicate-keys.md. The VitePress config srcExcludes **/internal/**, so the page stopped being published and the public URL — and thus the short link — became a dead end.

Fix

  • Move the page back to docs/security-duplicate-keys.md, restoring the exact /security-duplicate-keys URL the short link targets.
  • Add a sidebar entry under Administration & Security for discoverability.

Verified

  • npm run docs:build succeeds (no dead-link failures) and emits dist/security-duplicate-keys.html (title Duplicate Encryption Keys).
  • Single source of truth — nothing left under docs/internal/.
  • The page has no internal/relative .md links, so the move introduces no broken links.

Once this deploys, https://meshmonitor.org/security-duplicate-keys (and the bit.ly) resolve again.

🤖 Generated with Claude Code

The 'Duplicate Encryption Keys' page is a user-directed security warning
('If you were sent here, it's because your Node is vulnerable...') that
affected users reach via a public short link
(https://bit.ly/4okVACVhttps://meshmonitor.org/security-duplicate-keys).

PR #3138 moved it into docs/internal/dev-notes/, which is srcExclude'd
('**/internal/**') from the VitePress build — so the public URL started
returning 404 and the short link became a dead end.

Move it back to docs/security-duplicate-keys.md (restoring the exact
/security-duplicate-keys URL the short link targets) and add a sidebar entry
under Administration & Security for discoverability. Verified: docs build
succeeds and emits dist/security-duplicate-keys.html.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jun 18, 2026

Copy link
Copy Markdown

Claude finished @Yeraze's task —— View job


PR Review: docs: restore Duplicate Encryption Keys page to the public site

  • Gather context and read changed files
  • Review code quality and correctness
  • Post final review

Summary

This is a clean, minimal, and correct fix. The PR does exactly what it needs to — no more, no less.

Changes Reviewed

docs/.vitepress/config.mts (line 126) — Adds one sidebar entry:

{ text: 'Duplicate Encryption Keys', link: '/security-duplicate-keys' },

Correctly placed under Administration & Security in the /features/ sidebar group. The link path /security-duplicate-keys matches the file location docs/security-duplicate-keys.md, which VitePress will publish at that exact URL.

docs/security-duplicate-keys.md — Renamed (moved) from docs/internal/dev-notes/security-duplicate-keys.md back to docs/security-duplicate-keys.md. No content changes. The file contains no internal-relative .md links that would break with the move.

Verdict: LGTM ✅

  • Root cause correctly diagnosedsrcExclude: ['**/internal/**'] was swallowing the page.
  • Minimal diff — 1 line added to the sidebar config, 0 content changes to the page.
  • No broken links introduced — verified the page has no relative .md links.
  • URL restoreddocs/security-duplicate-keys.md → published at /security-duplicate-keys, matching the short link target.
  • Discoverability improved — sidebar entry added for users browsing the docs.

One minor note: the page footer still says **MeshMonitor Version:** 2.12.1+ (line 355). This is pre-existing and not introduced by this PR, so it's out of scope here — but worth a follow-up update to reflect the current version.

Same fix as the Duplicate Keys page for its sibling user-directed warning:
move docs/internal/dev-notes/security-low-entropy-keys.md back to
docs/security-low-entropy-keys.md so /security-low-entropy-keys is published
again, and add a sidebar entry under Administration & Security.

Also repoint automation.md's two 'Duplicate Encryption Keys' links from the
now-moved internal GitHub-blob path to the site-relative /security-duplicate-keys
(those would otherwise 404 after the move). The low-entropy page's relative
link to ./security-duplicate-keys.md resolves correctly now that both pages
live at the docs root.

Verified: docs build succeeds with no dead links; both pages emit HTML.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jun 18, 2026

Copy link
Copy Markdown

Claude finished @Yeraze's task —— View job


PR Review: docs: restore Duplicate Encryption Keys page to the public site

  • Gather context and read changed files
  • Review code quality and correctness
  • Post final review

Summary

Clean, correct fix. The PR does exactly what it needs to with no unintended side effects.

Changes Reviewed

docs/.vitepress/config.mts — Adds two sidebar entries under Administration & Security:

{ text: 'Duplicate Encryption Keys', link: '/security-duplicate-keys' },
{ text: 'Low-Entropy Encryption Keys', link: '/security-low-entropy-keys' },

Both link paths correctly match their respective file locations (docs/security-duplicate-keys.md, docs/security-low-entropy-keys.md). VitePress will publish them at those exact URLs.

docs/security-duplicate-keys.md — Renamed from docs/internal/dev-notes/security-duplicate-keys.md. No content changes. The srcExclude: ['**/internal/**'] VitePress config was silently swallowing this file; moving it out of internal/ restores the public URL.

docs/security-low-entropy-keys.md — Same story: renamed from docs/internal/dev-notes/security-low-entropy-keys.md. Both security warning pages are now published.

docs/features/automation.md — Two link fixes in the Auto Key Management section (lines ~1830–1834). Stale GitHub blob URLs replaced with proper VitePress-relative paths:

- [Duplicate Encryption Keys](https://github.com/Yeraze/meshmonitor/blob/main/docs/internal/dev-notes/security-duplicate-keys.md)
+ [Duplicate Encryption Keys](/security-duplicate-keys)

This is exactly right — the old links pointed at the raw GitHub file viewer (would show markdown source, not rendered docs), and now they point to the live docs site.

Verdict: LGTM ✅

  • Root cause correctly diagnosedsrcExclude: ['**/internal/**'] was swallowing both security pages.
  • Minimal diff — 2 sidebar entries added, 2 link fixes, 0 content changes to the pages.
  • No broken links introduced — neither page contains relative .md links that would break with the move.
  • Both short-link targets restored/security-duplicate-keys and /security-low-entropy-keys will now resolve.
  • Automation.md link quality improved — replaced raw GitHub blob URLs with proper docs-site relative paths (the old URLs showed raw markdown source, not the rendered page).

One pre-existing note out of scope for this PR: docs/security-duplicate-keys.md line 355 still shows **MeshMonitor Version:** 2.12.1+. Worth a follow-up update to reflect the current version (4.x).

@Yeraze Yeraze merged commit f212bfc into main Jun 18, 2026
20 checks passed
@Yeraze Yeraze deleted the fix/restore-security-duplicate-keys-page branch June 18, 2026 11:56
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