Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

Keep the Help index out of unshipped documentation routes

pulse-triage[bot]50fd9e3a54ec
diff --git a/docs/README.md b/docs/README.md
index 70d3cb64c2..7f9408b97b 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -4,6 +4,10 @@ Start here for installation, platform setup, security, operations, and Pulse
Intelligence. Commands, configuration keys, image names, API fields, and
product identifiers remain untranslated in localized guides.
+The local guides below are shipped with this installation. Links labelled
+**GitHub** open online resources in a new tab and need network access; their
+current content can differ from your installed version.
+
**Need help with a failure?** Read the
[safe reporting guidance](TROUBLESHOOTING.md#-getting-help) before sharing
evidence. A second reproduction or diagnostics export is not required; keep
@@ -57,7 +61,7 @@ integration against their own vCenter before production use.
- [Automatic updates](AUTO_UPDATE.md)
- [Centralized agent management](CENTRALIZED_MANAGEMENT.md) (Pro)
- [Operational trust model](OPERATIONAL_TRUST.md)
-- [Current product screenshots](SCREENSHOTS.md)
+- [Demo screenshots (GitHub)](https://github.com/rcourtman/Pulse/blob/main/docs/SCREENSHOTS.md)
## Pulse Intelligence
@@ -100,7 +104,7 @@ paths rather than defaults in self-hosted setup.
- [REST API](API.md)
- [Architecture](../ARCHITECTURE.md)
- [Contributing](../CONTRIBUTING.md)
-- [Release notes index](RELEASE_NOTES.md)
+- [Published release notes (GitHub)](https://github.com/rcourtman/Pulse/releases)
- [Development transparency disclosure](AI_TRANSPARENCY.md)
Detailed design notes and dated migration specifications may remain in this
diff --git a/frontend-modern/public/docs/README.md b/frontend-modern/public/docs/README.md
index 70d3cb64c2..7f9408b97b 100644
--- a/frontend-modern/public/docs/README.md
+++ b/frontend-modern/public/docs/README.md
@@ -4,6 +4,10 @@ Start here for installation, platform setup, security, operations, and Pulse
Intelligence. Commands, configuration keys, image names, API fields, and
product identifiers remain untranslated in localized guides.
+The local guides below are shipped with this installation. Links labelled
+**GitHub** open online resources in a new tab and need network access; their
+current content can differ from your installed version.
+
**Need help with a failure?** Read the
[safe reporting guidance](TROUBLESHOOTING.md#-getting-help) before sharing
evidence. A second reproduction or diagnostics export is not required; keep
@@ -57,7 +61,7 @@ integration against their own vCenter before production use.
- [Automatic updates](AUTO_UPDATE.md)
- [Centralized agent management](CENTRALIZED_MANAGEMENT.md) (Pro)
- [Operational trust model](OPERATIONAL_TRUST.md)
-- [Current product screenshots](SCREENSHOTS.md)
+- [Demo screenshots (GitHub)](https://github.com/rcourtman/Pulse/blob/main/docs/SCREENSHOTS.md)
## Pulse Intelligence
@@ -100,7 +104,7 @@ paths rather than defaults in self-hosted setup.
- [REST API](API.md)
- [Architecture](../ARCHITECTURE.md)
- [Contributing](../CONTRIBUTING.md)
-- [Release notes index](RELEASE_NOTES.md)
+- [Published release notes (GitHub)](https://github.com/rcourtman/Pulse/releases)
- [Development transparency disclosure](AI_TRANSPARENCY.md)
Detailed design notes and dated migration specifications may remain in this
diff --git a/frontend-modern/src/features/docs/__tests__/documentationIndex.test.ts b/frontend-modern/src/features/docs/__tests__/documentationIndex.test.ts
new file mode 100644
index 0000000000..f50906f088
--- /dev/null
+++ b/frontend-modern/src/features/docs/__tests__/documentationIndex.test.ts
@@ -0,0 +1,50 @@
+import { existsSync, readFileSync } from 'node:fs';
+import path from 'node:path';
+import { describe, expect, it } from 'vitest';
+import { createGuideFixture } from './guideFixture';
+
+const publicDocs = path.resolve(process.cwd(), 'public/docs');
+const read = (name: string) => readFileSync(path.join(publicDocs, `${name}.md`), 'utf8');
+const guide = createGuideFixture(read);
+
+describe('shipped documentation index', () => {
+ it('routes every local index link to a shipped guide and an existing fragment', () => {
+ const links = [...guide('README').querySelectorAll<HTMLAnchorElement>('a[data-doc-link]')];
+ expect(links.length).toBeGreaterThan(40);
+ const missing: string[] = [];
+ for (const link of links) {
+ const url = new URL(link.getAttribute('href')!, 'https://pulse.invalid');
+ const target = decodeURIComponent(url.pathname.slice('/docs/'.length));
+ if (!existsSync(path.join(publicDocs, `${target}.md`))) {
+ missing.push(`${link.textContent}: ${target}.md is not shipped`);
+ } else if (url.hash && !guide(target).querySelector(`[id="${url.hash.slice(1)}"]`)) {
+ missing.push(`${link.textContent}: ${target}${url.hash} is absent`);
+ }
+ }
+ expect(missing).toEqual([]);
+ });
+
+ it('uses labelled online references rather than unshipped routes or draft release packets', () => {
+ const article = guide('README');
+ for (const [label, url] of [
+ ['Demo screenshots (GitHub)', 'https://github.com/rcourtman/Pulse/blob/main/docs/SCREENSHOTS.md'],
+ ['Published release notes (GitHub)', 'https://github.com/rcourtman/Pulse/releases'],
+ ]) {
+ const link = [...article.querySelectorAll('a')].find((anchor) => anchor.textContent === label);
+ expect(link?.getAttribute('href')).toBe(url);
+ expect(link?.getAttribute('target')).toBe('_blank');
+ expect(link?.getAttribute('rel')).toBe('noopener noreferrer');
+ expect(link?.hasAttribute('data-doc-link')).toBe(false);
+ }
+ expect(article.textContent?.replace(/\s+/g, ' ')).toContain(
+ 'open online resources in a new tab and need network access',
+ );
+ expect(article.textContent?.replace(/\s+/g, ' ')).toContain(
+ 'current content can differ from your installed version',
+ );
+ });
+
+ it('keeps the repository and shipped index identical', () => {
+ expect(read('README')).toBe(readFileSync(path.resolve(process.cwd(), '../docs/README.md'), 'utf8'));
+ });
+});