Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocumentation
Device

Load Public Docs Index

Open the public Docs screen or call the unauthenticated Docs index API to retrieve grouped article summaries for navigation and search. The index is scoped by documentation locale, selected platform and theme, with optional server-side q filtering for direct API consumers.

In this article

Use this guide when support operators, implementation consultants or documentation maintainers need to confirm that the public Docs index is available without an Antylogic login.

The landing Docs screen loads the index from /api/public/docs and then filters the visible list locally. Direct API consumers can add q to the request when they need server-side filtering.

For the GB documentation target, use /docs?lang=en or pass locale=en so the generated English documentation is requested explicitly.

Before you start

  • Open the landing documentation route through /docs, /manual or /wiki.
  • Use English documentation for en-GB by opening the page with lang=en, or by calling the API with locale=en.
  • The browser or API client can reach PUBLIC_API_BASE_URL. Local landing runs normally use http://localhost:8081 unless configured differently.
  • The backend has a readable docs content bundle, normally backend/docs-content/articles.json or the path configured through DOCS_CONTENT_PATH.
  • No Harbor Demo Group login, organization membership, location role or demo session is required for this public index.

Instructions

  1. 1.

    Open the public Docs screen

    Open /docs?lang=en on the landing site. /manual and /wiki reach the same Docs screen. Keeping the language English makes the landing screen request locale=en from the public docs service.

  2. 2.

    Let the index request resolve

    The screen resolves the documentation locale, selected platform and active theme, then requests /api/public/docs with locale, platform and theme. Cookies may be included by the browser fetch setting, but the endpoint does not require authentication.

  3. 3.

    Review the grouped index

    After the request succeeds, review the returned sections and article summaries. The index is summary-only: article bodies, steps, validations, prerequisites and media URLs are loaded by article-detail actions instead.

  4. 4.

    Use q only for direct API filtering

    When calling the API directly, add q to return matching article summaries, for example /api/public/docs?locale=en&platform=mobile&theme=light&q=reservations. The landing Docs search input filters locally over the already loaded index and does not send q.

  5. 5.

    Confirm fallbacks and error states

    Unsupported platform values normalise to web, phone aliases normalise to mobile, ipad normalises to tablet, and missing or non-dark themes normalise to light. Direct GB captures should pass locale=en because backend locale fallback uses es when the request locale is missing or unsupported.

Validations and limits

  • The Docs screen loads without asking for a Harbor Demo Group login.
  • The public request includes locale=en, a platform value and the resolved theme.
  • The visible guide count matches article_count from the returned index.
  • Articles are grouped into sections derived from their category, with summaries exposing only index fields such as id, slug, section_slug, title, summary, icon_name and has_media.
  • A direct q request echoes the normalised query and still returns 200 with article_count: 0 and sections: [] when there are no matches.
  • Only GET and HEAD are accepted on /api/public/docs; other methods return 405.
  • HEAD /api/public/docs only proves shallow route reachability and should not be used as evidence that a specific article or current bundle exists.

Expected result

The public Docs index is loaded as grouped section navigation for the landing Docs screen or returned as unauthenticated JSON for direct consumers, with q filtering documented only for direct API calls.

Related articles