Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocumentation
Device

List the Docs index

Check the localised documentation index from the public Wiki and from the signed-in app. The index returns the version, normalised language, requested platform, article count and sections with summaries, without loading the full detail of each article.

In this article

Use this guide when you need to validate that the embedded documentation is available for the landing, the public Wiki and the app Docs screen.

The index is a read of the local documentation bundle: it neither queries nor modifies operational data for restaurants, bookings, POS, staff, organisations or locations.

Before you start

  • The documentation bundle must be deployed with `articles.json` in the configured content path.
  • `/api/public/docs`, `/docs`, `/manual` and `/wiki` require no session or permissions.
  • `/api/app/docs` and `antylogic://docs` require a valid Harbor Demo User session.
  • For public captures, the environment must expose `APP_WEB_URL` and a valid base for `PUBLIC_API_BASE_URL`.

Instructions

  1. 1.

    Open the public Wiki

    Open `/docs`, `/manual` or `/wiki`. The page must show Docs with sections and articles localised in English, without asking for sign-in, organisation or location.

  2. 2.

    Check the public contract

    Query `GET /api/public/docs?locale=en&platform=mobile`. The expected response is `200` with `version`, `locale`, `platform`, `article_count` and `sections`; each section contains summaries, not the full article detail.

  3. 3.

    Review language and platform

    Check that `locale=en-GB` becomes `en`, that `device=iphone` becomes `mobile` and that an unknown platform falls back to `web`. `theme` can be sent, but it does not change the visible index.

  4. 4.

    Interpret the sections

    Validate that `article_count` matches the sum of articles in `sections`. Each summary includes `id`, `slug`, `section_slug`, `title`, `summary`, `icon_name`, `has_media` and, when they exist, `action_id` and `primary_keyword`.

  5. 5.

    Open Docs with a session

    With the Harbor Demo User session active, open `antylogic://docs` or query `GET /api/app/docs?locale=en&platform=web`. The authenticated route requires a valid token, but no granular operational permissions.

  6. 6.

    Keep index, search and detail apart

    This action describes the base index. If `q` is sent, the handler filters by text; that case belongs to `docs.content.search-index`. The base index does not return `intro`, `prerequisites`, `steps`, `validations`, `result` or `media`.

Validations and limits

  • `/api/public/docs` does not depend on session, permissions, organisation or location.
  • `/api/app/docs` requires general authentication, not permissions such as `user-reports:manage`.
  • `platform` is echoed normalised in the response, but it does not filter index articles.
  • `theme` has no observable effect in this action.
  • If there are no articles for the normalised language, the response is still `200` with `article_count: 0` and `sections: []`.
  • If `articles.json` is missing, the API returns `503` with `documentacion no configurada`; if reading or decoding fails, it returns `500` with `documentacion no disponible`.
  • The `POST`, `PUT`, `PATCH` and `DELETE` methods are not part of this action.

Expected result

When you finish, you will have verified that the Docs index is delivered by the public Wiki, the public API, the authenticated API and the app Docs screen, keeping the responsibilities of index, search and detail separate.

Related articles