Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocumentation
Device

Search Loaded In-App Docs

Use the Search Docs field on the Docs screen to narrow the sections already loaded in the sidebar. Typing filters local article summaries only; it does not send a new backend search request and does not move the article pane until a filtered result is selected.

In this article

The Docs screen loads the documentation index first, using the resolved locale, platform and theme. In the GB en-GB demo, the visible search field is Search Docs.

This search is for quick navigation inside the loaded index. It checks article summary metadata and updates the sidebar in place.

Before you start

  • The user is signed in to the app.
  • The Docs screen is open from /docs, antylogic://docs, or User menu > Docs.
  • The Docs index has loaded and contains at least one article, so the Search Docs field is visible.
  • For GB en-GB captures, use the Harbor Demo User session and the English docs locale.

Instructions

  1. 1.

    Open Docs

    Open the Docs screen and wait for the index to finish loading. The sidebar shows Search Docs and an article count for the loaded index.

  2. 2.

    Filter The Sidebar

    Type a term such as access. The sidebar keeps only sections with matching article summaries, and matching sections stay open while the search field is not blank.

  3. 3.

    Clear The Search

    Delete the search text to restore the full loaded index. Normal section open and collapsed behaviour applies again after the field is empty.

  4. 4.

    Read No Results

    If the value does not match any loaded article summary, the sidebar shows No articles match this search. The current article pane remains controlled by the existing article state.

Validations and limits

  • Blank or whitespace-only search shows all loaded articles.
  • Search trims the value and matches case-insensitively.
  • The app matches only article title, summary, section slug, action id and primary keyword from the loaded summaries.
  • Typing in the field does not call /api/app/docs?q=... and does not change the Docs query params.
  • The article count remains the loaded index total, not the filtered match count.
  • Sections with no matching articles are removed from the sidebar, and the no-results message appears when no section remains.
  • The search has no ranking, highlighting, debounce, tokenisation or accent folding.

Expected result

The user narrows or restores the Docs sidebar locally. Backend docs content, user data and Harbor demo records are unchanged, and the open article changes only after the user selects a filtered result.

Related articles