Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocumentation
Device

Open Docs In The App

Open the authenticated in-app Documentation screen from the account menu or the `/docs` route. The screen is read-only, does not require a selected organisation or location, and loads the documentation index before selecting the first available article.

In this article

Use this guide when an operator, location manager, or support team member needs to open Antylogic guidance from inside the authenticated app. In the GB demo, the path starts from Harbor Demo User at Harbor Soho.

Opening Docs only loads guidance. It does not create support tickets, change restaurant data, or run a server-side search when the screen opens.

Before you start

  • The app is online, up to date, and has finished loading.
  • The user is signed in to the app.
  • If using the menu path, the account menu is available and is not locked by sign-out, demo cleanup, push-token deletion, or another account action.

Instructions

  1. 1.

    Open the authenticated workspace

    Start from the signed-in app, such as Harbor Soho in the GB demo. Make sure no login, offline, update-required, or account-recovery screen is blocking app navigation.

  2. 2.

    Open the account menu

    Open the user account menu for the current session. In the GB demo this is the Harbor Demo User account menu.

  3. 3.

    Choose Docs

    Select `Docs`. If the app is already on the Documentation screen, the menu simply closes. Otherwise, Antylogic opens the `Documentation` route.

  4. 4.

    Wait for the index to load

    The screen requests the docs index with the resolved locale, platform, and theme. When `/docs` opens without article parameters, the first available article is selected after the index returns.

  5. 5.

    Use the direct route when needed

    Open `/docs` or `antylogic://docs` to reach the same screen without using the menu. Use `antylogic://docs/:sectionSlug/:articleSlug` only when linking to a known article; article matching happens after the index has loaded.

Validations and limits

  • `Documentation` opens inside the authenticated app stack, so unauthenticated users cannot reach this screen directly.
  • No granular docs permission, selected organisation, or selected location is required for this route.
  • Use `/docs` or `antylogic://docs`; do not document this as a contextual `/{orgId}/{locationId}/docs` route.
  • The screen is read-only and does not mutate product data or create support tickets.
  • The native search box filters locally after the index has loaded; this action should not be described as sending a server-side `q` search.
  • Invalid article slugs or unmatched legacy `articleId` values leave no selected article until the loaded index can resolve a match.

Expected result

The user lands on the read-only Documentation screen. When content is available, the screen shows Docs, the search field, the section list, and the selected first article.

Related articles