Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocumentation
Device

Open the public Docs index

Open the Antylogic public wiki from `/docs` to consult the index of available guides without signing in, selecting an organisation or loading demo data.

In this article

Public Docs is the landing's help entry point. It serves an index of operational guides for visitors and users who want to consult documentation before entering the app.

The screen resolves language, device and theme, loads summaries from the public API and leaves the full detail of each guide to the article flow.

Before you start

  • The Antylogic public landing is available at `/docs`, `/manual` or `/wiki`.
  • The public documentation API is reachable from `PUBLIC_API_BASE_URL`; locally the landing uses `http://localhost:8081` as fallback.
  • Published content exists in `backend/docs-content/articles.json` for `es` or `en`.
  • There is no need to sign in, select an organisation, select a location or prepare Harbor Demo Group.

Instructions

  1. 1.

    Open public Docs

    Enter `/docs?lang=en`. It can also be reached from `/manual` or `/wiki`, although internal links go back to the canonical `/docs` route.

  2. 2.

    Confirm language and device

    The landing limits the Docs language to `es` or `en`, detects the initial platform as mobile, tablet or web, and applies the active light or dark theme.

  3. 3.

    Load the index

    The screen requests `GET /api/public/docs` with `locale`, `platform` and `theme`. The index groups articles by section and shows summaries, not the full body of each guide.

  4. 4.

    Search for a guide

    Use the visible search box to filter the already loaded index locally. That search does not send `q` to the backend in the screen's normal flow.

  5. 5.

    Enter an article

    If the URL does not point to a specific guide and there are articles, Docs selects the first summary and replaces the route with `/docs/{section_slug}/{slug}` to load the detail.

  6. 6.

    Validate public variants

    For support or integrations, query `HEAD /api/public/docs` or `GET /api/public/docs?locale=en-GB&device=iphone&q=bookings` directly. Those cases document the API contract, not the landing's normal search box.

Validations and limits

  • `GET /api/public/docs` and `HEAD /api/public/docs` are public and require no user permission.
  • The public endpoint only accepts `GET` and `HEAD`; other methods return `405` with `metodo no permitido`.
  • If the content service or file is missing, the API returns `503`; if the JSON cannot be read or decoded, it returns `500`.
  • Unrecognised language, platform or theme values are normalised to defaults; they are not treated as strict validation errors.
  • The index returns summaries with `article_count`, `sections`, `icon_name` and `has_media`; steps, validations and resources are obtained from the article detail.
  • The screen shows `Docs could not be loaded.` when the public response is not `2xx` or the network fails.
  • Assets are served from the detail flow and only if the path stays inside `DOCS_ASSETS_PATH`.

Expected result

The visitor sees the public Docs index with sections, a guide counter, a device selector and navigation to the first article, with no session or organisation context.

Related articles