<!-- Source: https://docs.vib.tools/vib-docs-engine/portal-user-guide/ | Product: Vib Docs Engine -->

# Portal User Guide

This guide describes the behavior implemented by the current static portal. Product pages and available controls are generated from the portal's build-time manifest.

## Hub

Open the portal root to browse product cards. Each card opens that product's documentation. Category filter tabs appear only when the configured catalog has more than one unique category; otherwise the filter bar is omitted. When shown, select a category to filter the cards or choose `All` to reset. Product cards display the configured/generated title, description, category, version when present, and either the synchronized logo or a monogram.

## Search

Press `Ctrl+K` (or `Cmd+K` on macOS), or use the search button in the header. Search code and index are downloaded only when the modal first opens. On a product page, search starts with `Current Product Only`; choose `All Docs` to search across the portal. On the Hub, the search is global. Select a result to open its page. Close the modal with `Escape` or by clicking the backdrop. In development before a production index exists, the modal explains that search is generated by `npm run build`.

## Documentation pages

The product header links back to the Hub, switches between configured products, opens search, follows the product CTA when configured, and toggles the light/dark theme. Use the left sidebar for nested pages; on narrow screens its menu button opens a drawer that closes with Escape, the close control, or a navigation link. The right `On This Page` list links to H2/H3 headings and follows the current section while scrolling. At the end of an article, `Edit this page on Git` opens the source editor and Previous/Next links follow the manifest page order.

The 404 page links back to the Hub and can open search. Product names, categories, links, logos, and CTA destinations vary by portal configuration.
