Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocumentation
Device

Search Public Docs Locally

Use the public Docs search box to narrow the articles already loaded in the browser for the current language, platform and theme. The filter is local to the page after the Docs index has loaded and does not start a new server search.

In this article

The public Docs search helps restaurant operators, front-of-house managers and support users find relevant public guides without signing in.

Search works against the loaded Docs index for the current documentation context. It is immediate, case-insensitive and keeps the current article open until you select a filtered result.

Before you start

  • Open a public Docs route handled by the Docs screen: `/docs`, `/manual` or `/wiki`. For English documentation, use `/docs?lang=en`.
  • Wait for the Docs index to finish loading from `GET /api/public/docs?locale={locale}&platform={platform}&theme={theme}`.
  • No sign-in, organisation membership or location membership is required.

Instructions

  1. 1.

    Open Public Docs

    Open `/docs?lang=en` and wait until the public Docs index is visible. The guide count beside the search box remains the total loaded article count, not the filtered result count.

  2. 2.

    Search The Loaded Index

    Click the `Search` input in the Docs sidebar and type a term such as `Access`. The sidebar narrows immediately without leaving the page and without sending a new `/api/public/docs?q=...` request.

  3. 3.

    Review Matching Articles

    Use the filtered sidebar links to find the guide you need. Matching sections open automatically, sections without matches are hidden, and results keep the same section and article order returned by the loaded index.

  4. 4.

    Clear The Search

    Delete the search term to show every loaded article again, or replace it with another term to refilter the same loaded index. The search term is not stored in the URL or local storage.

  5. 5.

    Handle No Matches

    If no desktop sidebar article matches the query, the page shows `No articles match that search.`. On the mobile Docs sections panel, the same filtered list is used, but this desktop empty-search message is not rendered.

Validations and limits

  • Search is normalised only with `trim().toLowerCase()`; there is no minimum length, debounce, stemming, tokenisation or accent folding.
  • Searchable article fields are limited to title, summary, section slug, action id and primary keyword.
  • The local search does not search article body text, article id, slug, source guide id, section title, intro, prerequisites, steps, validations, media metadata or related articles.
  • Typing in the public Docs search box does not make a new `/api/public/docs?q=...` request, even though the backend Docs API supports a `q` parameter.
  • A `q` parameter in the browser URL does not initialise the search field.
  • Only `es` and `en` Docs content is generated in the current landing screen configuration; other landing languages fall back to English Docs content.

Expected result

The public Docs sidebar shows only articles from the already-loaded index that match the local query. Clearing the query restores the full loaded index.

Related articles