Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocumentation
Device

Search within Docs

Find articles from the Docs screen using the `Search Docs` field. The search filters on the client the documentation index already loaded for the current session, language, device and theme; it does not create, edit or delete Harbor Demo Group data and does not turn the visible text into a shareable query.

In this article

Use this guide when a front-of-house, operations or administration person needs to find a help topic inside Antylogic without leaving the Docs screen.

The visible search box works over the sections already loaded by `GET /api/app/docs`. Although the API also accepts `q`, `DocumentationPage` does not use it for the visible field: it loads the index with `locale`, `platform` and `theme`, and then filters locally.

Before you start

  • Have an active session in the Antylogic app.
  • Open Docs from the user menu or through `antylogic://docs`.
  • Wait for the screen to finish loading the index before typing in the search box.
  • Have Docs articles available for the current language and device.

Instructions

  1. 1.

    Open Docs

    Enter Docs from the user menu or open `antylogic://docs`. If you arrive with a link to an article, such as `antylogic://docs/:sectionSlug/:articleSlug`, the sidebar keeps the search box.

  2. 2.

    Search for a term

    Type a word in `Search Docs`. For an English capture, use `bookings`, because it exists in the Docs content and shows real results without preparing additional operational data.

  3. 3.

    Review the filtered list

    The sidebar keeps only sections with matching articles. While the field has text, the resulting sections are shown open to make choosing an article easier.

  4. 4.

    Open an article

    Select an article from the filtered list to view its detail. If an article was already open before searching, it may remain visible until you choose another result.

  5. 5.

    Clear or try with no results

    Clear the field to recover all the articles from the loaded index. To document the empty state, type a non-existent term such as `zzzz`.

Validations and limits

  • The action is read-only and does not modify restaurant entities.
  • The visible input filters the already loaded `docsIndexQuery.data.sections` and does not fire a new request on every change.
  • `DocumentationPage` does not pass `q` from the visible search box; the counter next to the search box keeps showing the total of the loaded index.
  • The local match uses `title`, `summary`, `section_slug`, `action_id` and `primary_keyword`.
  • The search trims whitespace, compares in lowercase and works by substring; there is no ranking, fuzzy search or accent normalisation.
  • An empty or whitespace-only search restores all visible articles.
  • If there are no matches, the screen shows `No articles match this search.`
  • The searched text is not reflected in the URL, route params or query key, so it is not a linkable state.

Expected result

The user finds and opens a Docs article from the already loaded index, without creating or modifying data. When the field is cleared, the list shows again every article available for the current session, language, device and theme.

Related articles