Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocumentation
Device

Select an article

The Documentation screen decides which article to open from a direct route, a legacy articleId or the first available article in the index. It is a read-only query: it loads the authenticated index and detail from Docs without modifying operational data.

In this article

Use this guide to understand how Docs opens the right article when a user enters from the menu, from a direct link or from another internal documentation link.

Selection is always resolved against the loaded index: first section and article slug, then a normalised legacy articleId and, only when there is no explicit selection, the first available article.

Before you start

  • The user must be signed in to query the app Docs endpoints.
  • The documentation content must be available in the runtime environment.
  • The screen must be opened from User menu > Docs, from antylogic://docs or from a direct route with sectionSlug and articleSlug.
  • For captures, use the GB demo Harbor Demo Group with the Harbor Demo User session and the Harbor Soho location.

Instructions

  1. 1.

    Open Docs

    Enter Docs from the user menu or open a direct link. If the route includes a section and an article, such as antylogic://docs/access/en-auth-native-login, the screen tries to resolve exactly that article. If only antylogic://docs is opened, it loads the index and selects the first available article.

  2. 2.

    Load the index

    The screen requests GET /api/app/docs with locale, platform and theme. In the GB demo the language resolves to en. While loading, Loading documentation may appear; when the index arrives, the app groups the articles by section and prepares the side list.

  3. 3.

    Confirm the selection

    Check that the expected article is highlighted and that the corresponding section is open. If the selection comes from articleId, the app normalises it and then leaves the route with sectionSlug and articleSlug.

  4. 4.

    Review the detail

    When there is a valid summary, the app requests GET /api/app/docs/{sectionSlug}/{articleSlug} with the same index parameters and renders the title, summary, prerequisites, steps, checks, result, captures when they exist and related articles.

  5. 5.

    Change article

    Select another article from the side list or from related articles. The screen navigates again to Documentation with the chosen article's section and slug, highlights that link and loads its detail.

Validations and limits

  • The real priority is sectionSlug + articleSlug, then legacy articleId, then the first article in the index.
  • An invalid full route does not automatically fall back to the first article; it shows the select-an-article state.
  • The visible search on the screen filters the already received index locally; it does not send q to the backend in this flow.
  • Do not document that platform or theme filter index articles; in the verified behaviour they affect parameters, metadata and media.
  • Do not invent functional Docs permissions: the access found depends on an authenticated session.
  • The action is read-only and does not modify bookings, POS, catalogues, employees or Harbor Demo Group data.

Expected result

Docs stays open with the selected article, the route canonicalised when appropriate and the detail loaded from the authenticated documentation content.

Related articles