Skip to content

Index key website pages into docs search#73

Merged
scsmith merged 3 commits into
mainfrom
index-website-pages
Jul 7, 2026
Merged

Index key website pages into docs search#73
scsmith merged 3 commits into
mainfrom
index-website-pages

Conversation

@scsmith

@scsmith scsmith commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Docs search couldn't answer queries for content that lives on the main site — gdpr, dpa, cancel and pricing all returned nothing (7 of the 28 zero-result searches in the last 90 days were the GDPR/DPA cluster). A postprocess step now fetches the pages listed under algolia: external_pages in config.yaml and indexes them alongside the docs content, with the page URL as the objectID so search results link straight to the site. Also adds a short cancelling-your-account doc — deliberately not in the sidebar; it's there for people who search for it. The first commit fixes the stale outbound/senders and privacy-and-security links that were failing the external_links check on every build.

Verified against a scratch index: gdpr/dpa → Security and Privacy Policy, cancel → Refund Policy, pricing → Plans & Pricing. A fetch failure warns and skips the page rather than failing the build.

@scsmith scsmith force-pushed the index-website-pages branch from ce6deb1 to e647e73 Compare July 6, 2026 16:05
scsmith added 3 commits July 6, 2026 17:10
outbound/senders became outbound/sources and privacy-and-security
became legal/security-and-privacy-policy; the external_links check has
been failing on the redirects.
Docs search showed people looking for how to cancel without finding
anything. Deliberately not linked in the sidebar — it's there for
people who search for it.
Docs search couldn't answer queries for content that lives on the main
site (gdpr, dpa, cancel and pricing all returned nothing). A
postprocess step now fetches the pages listed under
algolia:external_pages in config.yaml and indexes them alongside the
docs content, with the page URL as the objectID so results link
straight to the site.
@scsmith scsmith force-pushed the index-website-pages branch from e647e73 to 7c696f9 Compare July 6, 2026 16:11
@scsmith scsmith merged commit 0f1ef65 into main Jul 7, 2026
1 check passed
@scsmith scsmith deleted the index-website-pages branch July 7, 2026 09:44
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