Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocumentation
Device

Open An In-App Article

Open the authenticated Documentation screen, resolve the Access article from the loaded docs index, and read the English article for Harbor Soho.

In this article

Use this guide when a signed-in Antylogic user needs to open a specific in-app help article from a stable Documentation route. In the GB demo, the route opens Create an Internal Location User for Harbor Soho.

This action is read-only. The app loads the docs index first, confirms the article exists for the current language, then renders the selected article detail.

Before you start

  • You are signed in to the app as Harbor Demo User or another authenticated app user.
  • The app language resolves to English. For en-GB sessions, the app sends locale=en to the docs API.
  • The Documentation screen can load the docs index from /api/app/docs.
  • The article exists in the loaded docs index. No selected organisation or location is required.

Instructions

  1. 1.

    Open Documentation

    Open Documentation from the app or use antylogic://docs. The screen loads the docs index with the current language, platform, and theme.

  2. 2.

    Open the article route

    Open antylogic://docs/access/en-access-users-create-location-internal. The screen trims the route values and looks for section_slug access and slug en-access-users-create-location-internal in the loaded index.

  3. 3.

    Confirm the selected article

    Check that Access is open in the sidebar and Create an Internal Location User is selected. The page writes the canonical sectionSlug and articleSlug back to the route.

  4. 4.

    Read the article detail

    Read the overview, prerequisites, ordered steps, validation checks, expected result, media placeholders, and related articles. Wide layouts also show a table of contents.

  5. 5.

    Open another article

    Select another sidebar item or related article. Documentation reuses the same route with the new sectionSlug and articleSlug.

  6. 6.

    Handle missing content

    If the route does not match the loaded index, return to Documentation and select an available article. The app does not fetch article detail for unmatched slugs.

Validations and limits

  • /api/app/docs requires an authenticated app session, but no docs-specific permission is implemented after authentication.
  • The app fetches article detail only after both slugs match an article summary in the loaded index.
  • The detail request URL-encodes sectionSlug and articleSlug and sends locale, platform, and theme.
  • The public /api/public/docs surface is separate from this authenticated app action.
  • The current GB target article exists, but its media entries are planned and do not expose publicSrc in the current bundle.

Expected result

The English Documentation screen shows the Access article Create an Internal Location User for Harbor Soho, with the article detail rendered from the authenticated docs API.

Related articles