Skip to content

docs(user-guide): add Search Your Templates for the templates search box - #880

Draft
danielfsousa wants to merge 2 commits into
mainfrom
docs/searching-templates
Draft

danielfsousa wants to merge 2 commits into
mainfrom
docs/searching-templates

Conversation

@danielfsousa

@danielfsousa danielfsousa commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

Refs SparkPost/email-monorepo#964. Refs SparkPost/email-monorepo#961, the templates page. Refs SparkPost/email-monorepo#948, the epic.

Important

Do not merge before production phase 3 starts. The article publishes at the start of phase 3, before the API pages in SparkPost/developers.sparkpost.com#598. It stays a draft until then.

Summary

The new Templates page searches every template in an account, and no support article says how to use its box. This PR adds a user-guide article, Search Your Templates, written in the style of Stripe's dashboard search page and GitHub's guide to filtering issues. It covers what you can type, what the controls do, and how to share a search. It leaves out the grammar's internals.

Changes

  • content/docs/user-guide/searching-templates.md has sections to search for a template, filter by status, sort and page through results, and share a search. Then come named examples, a syntax table, a table of the fields you can search, and a link to the API's Search page.
  • content/docs/user-guide/media/searching-templates/ holds three screenshots, embedded in the article.

Choices worth knowing

  • The article describes the 2web2ui templates page on main, not spec section 14, where the two differ. The Status dropdown writes status:… into the box. Sort is Last Updated only. There is no last-page control and no subaccount dropdown. A shared URL holds the search and the sort, so it opens on page 1.
  • Every query in the article parses with the search service's query.Parse, and the error it quotes, AND needs a term after it, is the service's real message.

Screenshots

Taken from the new Templates page on tst on 2026-11-09. They're cropped below Recent Activity, so only generic system and test templates are in frame. They live in content/docs/user-guide/media/searching-templates/:

File Section Shows
templates-search-results.png Search for a template payment in the box, with three matching templates
templates-status-filter.png Filter by status the Status filter open with Published ticked, and payment status:published in the box
templates-search-controls.png Sort and page through results status:published at 10 per page, with the paging arrows, the per-page buttons and Save As CSV

There's no screenshot of the address bar, because the capture tool records only the page, not the browser's toolbar. The Share a search section is text only.

Proof

Run locally on 2026-11-09 at commit 49f69ae3.

What Where Result
Every query in the article query.Parse in search-api each one parses, and welcome AND fails with AND needs a term after it
The page renders local next dev, Node 16.18 every heading, both tables and all three images render
Prettier local passes
next build and the Cypress tests not run

Verification

  1. The article renders with its sections, examples and tables on the deploy preview, at /docs/user-guide/searching-templates/.
  2. On tst, each example in the article finds the templates it describes when typed into the box on the new Templates page.

The new Templates page searches through the Search API, so its box takes
words, filters, OR, negation, quotes and dates. The article covers what
you can type, what the Status filter, sort, paging, per-page and Save as
CSV controls do, and sharing a search by its URL.

Refs SparkPost/email-monorepo#964
@netlify

netlify Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for support-docs ready!

Name Link
🔨 Latest commit 49f69ae
🔍 Latest deploy log https://app.netlify.com/projects/support-docs/deploys/6af233e1a828c803d5c9ba68
😎 Deploy Preview https://deploy-preview-880--support-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.

Three screenshots of the new Templates page on tst: a search with its
results, the Status filter writing status:published into the box, and
the table's sort, paging and per-page controls.

Refs SparkPost/email-monorepo#964
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant