Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocumentation
Device

Read In-App Article Content

Open an authenticated Docs article in Antylogic and read its guidance without changing restaurant data. The screen loads the selected article from the bundled Docs content and shows the title, summary, overview, prerequisites, numbered steps, checks, expected result, related articles, and the wide-screen contents panel when available.

In this article

Use this guide when a manager, operator, or support user needs to read Antylogic guidance inside the signed-in app.

For the GB demo session, the stable example is the English article at antylogic://docs/access/en-access-users-create-location-internal. It opens read-only documentation for Harbor Soho and does not create or update business records.

Before you start

  • You are signed in to the Antylogic app.
  • The Documentation screen is available from the authenticated app menu or an antylogic://docs/... deep link.
  • The Docs index has loaded and contains the article you want to read.
  • For the GB demo session, use antylogic://docs/access/en-access-users-create-location-internal.
  • Use a viewport at least 1180px wide only when you need to show the right-side Contents panel.

Instructions

  1. 1.

    Open Documentation

    Open Documentation from the authenticated app menu, or open a direct docs link such as antylogic://docs/access/en-access-users-create-location-internal. The in-app route requires authentication, but it does not require a selected organisation or location.

  2. 2.

    Wait for the article to resolve

    Antylogic matches the requested section and article against the loaded Docs index. If no article is supplied, it opens the first available article; if an older articleId link is used, the app replaces it with the current section and article slugs.

  3. 3.

    Confirm the article identity

    Use the breadcrumb, title, summary, and Overview section to confirm you are reading the intended article. In the GB demo, en-GB is sent to the Docs API as en, so English labels and English bundled article content are expected.

  4. 4.

    Read the guidance sections

    Review Before you start when it is present, then follow the numbered Steps. Use Checks to confirm expected conditions and Expected result to understand the outcome described by the article.

  5. 5.

    Use supporting navigation

    On wide screens, use Contents as a quick list of the sections that exist in the loaded article. Use Related articles to continue reading guidance from the same Docs section.

Validations and limits

  • The in-app article path uses /api/app/docs, not /api/public/docs.
  • The article request is enabled only after both sectionSlug and articleSlug are known.
  • While the detail request loads, the article column shows Loading article.... If it fails, it shows Docs could not be loaded.
  • If the requested article is not in the loaded index, no detail request is made and the screen asks the user to select an article.
  • Empty prerequisites, steps, checks, media, or expected-result fields are hidden instead of rendering blank sections.
  • Steps are displayed in article order and numbered from 1.
  • The Contents panel appears only at widths of at least 1180px and is informational only.
  • Related articles come from the same section, exclude the current article, and are limited to four.

Expected result

The user can read the authenticated in-app Docs article, review its guidance, and move to related documentation without changing Harbor Demo Group, Harbor Soho, or any operational data.

Related articles