Antylogic
DemoApp login

399 operational guides

Docs sections
DocsPublic Docs
Device

Read Public Article Content

Open a public Antylogic Docs article and read the rendered guidance, including the title, overview, prerequisites, ordered instructions, checks, media state, expected result, related guides, and section navigation. The page is public and does not require an authenticated Antylogic session.

In this article

Use this guide when a public visitor, restaurant operator, or support teammate needs to read an Antylogic Docs article from the landing manual without signing in.

The article page is driven by the generated Docs index and article detail content. It resolves the route, loads the article body, and shows only the sections that exist in the generated bundle.

Before you start

  • The public Docs route is available through `/docs`, `/manual`, or `/wiki`.
  • The article exists in the generated Docs bundle for the selected Docs locale.
  • For English GB captures, open the article with `lang=en` so the public Docs page resolves English content.
  • The backend public Docs service is configured with the generated docs content bundle and any public asset root needed for media.

Instructions

  1. 1.

    Open the public article URL

    Open a canonical article URL such as `/docs/access/en-access-users-create-location-internal?lang=en`. If the visitor enters through `/manual` or `/wiki`, or opens an older article path, the page resolves the article from the Docs index and navigates to the canonical `/docs/{sectionSlug}/{articleSlug}` route.

  2. 2.

    Confirm the article header and navigation

    Use the header to confirm that the expected article loaded. The page shows the Docs breadcrumb, section name, device selector, article title, summary, and feedback notice. The left navigation expands the selected section, and the right rail lists the article sections available on the page.

  3. 3.

    Read the overview and prerequisites

    Start with the overview paragraphs and prerequisites when they are present. The overview comes from the article `intro`, and prerequisites are shown only when the generated article includes them.

  4. 4.

    Follow the ordered instructions

    Read each numbered instruction in order. Every step uses the returned title and description, and the right-side contents list can jump directly to stable anchors based on the article slug and step number.

  5. 5.

    Review checks and expected result

    Use the validation checks and expected result to confirm what should be true after following the article. These sections are conditional, so an article may show checks, an expected result, both, or neither.

  6. 6.

    Use media and related guides

    Review the primary media near the top of the article and any additional captures later in the page. If the generated bundle contains planned media without a public source, the page shows the pending-generation placeholder. Related guides come from the same loaded section and exclude the current article.

Validations and limits

  • No sign-in, organisation membership, location membership, or product permission is required.
  • The public article flow is read-only and does not create reports, authenticate visitors, or change Antylogic data.
  • The frontend loads the Docs index before the article detail because route resolution depends on `DocsArticleSummary` values.
  • The article detail request uses `locale`, `platform`, and `theme`; search query `q` is not part of this action.
  • The breadcrumb shows `Docs` and the returned section title; it does not add the article title as a breadcrumb segment.
  • Sections for prerequisites, steps, validations, media, result, and related guides are omitted when the article has no source content for them.
  • When a media item has no resolved source, the page shows the pending-generation placeholder instead of inventing an image or video.
  • Related guides are selected from the same loaded section, exclude the current article, and are limited to three items.
  • Only generated Docs locales `en` and `es` are requested by the landing page; other landing UI languages fall back to English Docs content in `WikiScreen`.
  • `HEAD` checks on public Docs routes confirm service availability only and should not be described as article-content lookup.

Expected result

The visitor can read the public article, follow its instructions and checks, understand any media or pending media state, and continue to related guides without signing in or changing Antylogic data.

Related articles