Skip to content

docs: add discovery validation tooling#2120

Open
desimone wants to merge 4 commits intomainfrom
bdd/docs-discovery-validation
Open

docs: add discovery validation tooling#2120
desimone wants to merge 4 commits intomainfrom
bdd/docs-discovery-validation

Conversation

@desimone
Copy link
Copy Markdown
Contributor

Add the docs-side validation tooling for discovery and retrieval work.

What changed

  • add a standalone docs audit for frontmatter and llms.txt issues
  • add a retrieval benchmark scaffold and prompt set for current docs questions
  • add a flexible discovery smoke check for root/docs/agent surfaces
  • wire the scripts into package.json without making them a default build gate

Why

  • ENG-3735 needs reproducible validation, not just one-off manual checks
  • the earlier audit/benchmark branch was cut before the repo-wide Prettier normalization and before the shared-LB docs/marketing split was fully accounted for
  • the smoke check now understands preview-vs-canonical divergence via --base-url and --canonical-base-url, which matters for www.pomerium.com because root traffic defaults to marketing and docs is path-routed behind the LB

Validation

  • yarn build
  • yarn run check
  • node scripts/retrieval-benchmark.mjs init --output <file>
  • node scripts/retrieval-benchmark.mjs score --input <file>
  • node scripts/discovery-smoke-check.mjs --base-url https://deploy-preview-2117--pomerium-docs.netlify.app --canonical-base-url https://www.pomerium.com --check robots,docsSitemap,llms
  • node scripts/discovery-smoke-check.mjs --base-url https://deploy-preview-2116--pomerium-docs.netlify.app --canonical-base-url https://www.pomerium.com --check llms,llmsFull

Related

AI assistance

  • Codex drafted the implementation, ran the validation steps above, and refreshed the branch onto current main
  • Claude reviewed the final tooling diff and found no material issues; the only follow-up it suggested that I kept was adding a timeout to the smoke-check fetches and using yarn build consistently in the strict audit script

@desimone desimone requested a review from a team as a code owner March 19, 2026 04:36
@desimone desimone requested review from nickytonline and removed request for a team March 19, 2026 04:36
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 19, 2026

Deploy Preview for pomerium-docs ready!

Name Link
🔨 Latest commit ce8ef50
🔍 Latest deploy log https://app.netlify.com/projects/pomerium-docs/deploys/69bb7d4e9fba7d0008d2efb2
😎 Deploy Preview https://deploy-preview-2120--pomerium-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.

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