Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocumentation
Device

Open the Docs screen

Open the authenticated Docs surface from the user menu or from a direct link. The app loads the index with language, platform and theme computed on the client, without requiring an active location or support permissions.

In this article

Use this guide when a Harbor Demo Group operator needs to consult the internal documentation from the app while working in an authenticated session.

Docs is a global help surface. It can be opened from the user menu or with `antylogic://docs`, and it does not depend on having Harbor Soho or any other active location selected.

Before you start

  • Have an authenticated session or an active demo session, for example Harbor Demo User in Harbor Demo Group.
  • Have the Docs backend available with `articles.json` configured for `/api/app/docs`.
  • Use the app with its normal language, theme and screen size contexts, because `locale`, `theme` and `platform` come from there.
  • No location needs to be selected: Docs sits outside the operational venue context.

Instructions

  1. 1.

    Sign in with a valid session

    Open the app with an authenticated user or with the GB demo session. If there is no session, the app shows Login and does not mount the main surface where Docs lives.

  2. 2.

    Open Docs from the user menu

    Open the user account menu and press `Docs`. This is the recommended entry for operators who are already working inside the application.

  3. 3.

    Use a direct link when appropriate

    You can also open `antylogic://docs`. If the link includes a section and an article, such as `antylogic://docs/access/en-auth-native-login`, the same screen tries to resolve that article on load.

  4. 4.

    Wait for the index to load

    On entry, the screen computes `locale`, `platform` and `theme`, and requests the authenticated index from `GET /api/app/docs` with those parameters.

  5. 5.

    Review the Docs screen

    When the index responds, check that the `Docs` title, the local search box, the article count, the sections and the platform pill computed by the app are visible.

  6. 6.

    Recognise openings with an initial article

    If the link carries article parameters or the screen selects the first available article, the detail may load as a side effect of the opening. Full reading belongs to the `documentation.app.select-article` flow.

Validations and limits

  • The screen only mounts with an authenticated session; `/api/app/docs` is protected by `requireAuth`.
  • Do not document `user-reports:manage` as a requirement: that permission applies to the support inbox, not to opening Docs.
  • `locale` uses `en` if the language starts with English; in any other case it uses `es`.
  • `platform` is computed from the screen width: `<768` is `mobile`, `<1180` is `tablet` and the rest is `web`.
  • The normal opening does not send `q`; the visible search box filters the already loaded index locally.
  • Do not mix this guide with `/api/public/docs`; this documents the authenticated app surface.
  • If `articles.json` is missing or the Docs service is not configured, the screen shows the load error state.

Expected result

The user reaches Docs with the authenticated index loaded for their language, platform and theme. The action is read-only: it creates no business data, support tickets or configuration changes.

Related articles