Skip to content

Docs quality pass: SEO descriptions, broken links, screenshot pipeline - #108

Open
nicdavidson wants to merge 1 commit into
mainfrom
docs/quality-pass-2026-08
Open

Docs quality pass: SEO descriptions, broken links, screenshot pipeline#108
nicdavidson wants to merge 1 commit into
mainfrom
docs/quality-pass-2026-08

Conversation

@nicdavidson

Copy link
Copy Markdown
Collaborator

What

  • SEO: meta descriptions added to the 13 pages that lacked them; every non-partial doc page now has one (120-155 chars, factual).
  • Broken links: fixed all of them — the footer linked /introduction (broken on all 86 pages; the intro page's slug is /), 14 pages carried stale pre-migration paths (/api-security/*, numbered the-system-api slugs, etc.), plus two slug mismatches and two broken anchors. npm run build is now completely clean of link/anchor warnings.
  • Screenshot pipeline: scripts/shots.mjs (Playwright) logs into a live admin instance and captures every sidebar page for refreshing the 2024-era screenshots; stages to .shots/ (gitignored) for review. Screenshot refresh lands as a follow-up PR.
  • Docs debt: rate limiting has no docs page at all — four pages linked to one that never existed. Logged in docs-debt/, links retargeted to the auth guide as a stopgap; a real Limits page is queued.

Testing

npm run build passes with zero broken-link and zero broken-anchor warnings (previously ~110 broken links across 12 target paths).

@netlify

netlify Bot commented Aug 22, 2026

Copy link
Copy Markdown

Deploy Preview for dreamfactory-docs ready!

Name Link
🔨 Latest commit 13952ca
🔍 Latest deploy log https://app.netlify.com/projects/dreamfactory-docs/deploys/6a88f75120d90c00072a3664
😎 Deploy Preview https://deploy-preview-108--dreamfactory-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

- Add SEO meta descriptions to the 13 pages missing them (all pages covered now)
- Fix all broken links (footer /introduction on every page, 14 pages of stale
  paths, slug mismatches) and both broken anchors: build is now warning-clean
- Add scripts/shots.mjs: Playwright capture of the live admin UI for
  refreshing outdated screenshots (creds via DF_EMAIL/DF_PASS env only)
- Log missing rate-limiting docs page as docs-debt
@nicdavidson
nicdavidson force-pushed the docs/quality-pass-2026-08 branch from 3064b1b to 13952ca Compare August 22, 2026 01:11
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