Skip to main content

Tutorial: Using the Map Alongside the Docs Panel

One of Benchmrk's key features is the ability to read documentation and interact with the map at the same time. The DocsPanel renders this documentation site in a sidebar alongside the map, so you can follow tutorials and explore the map without switching tabs. This page explains how the two work together.

How the layout works​

When the DocsPanel is open, the app splits the screen between the map and the documentation panel:

  • Map canvas — Takes up the remaining space on the left side of the screen. The map automatically resizes when the DocsPanel opens or closes.
  • DocsPanel — Appears on the right side as a sidebar panel. You can scroll through documentation pages, click links, and navigate the docs hierarchy.

The map remains fully interactive while the DocsPanel is open. You can zoom, pan, click on survey marks, and use all map features without closing the docs.

Map resize behaviour​

When the DocsPanel opens:

  1. The map canvas shrinks to make room for the panel.
  2. The map automatically adjusts the viewport to fit the new dimensions.
  3. The map centre and zoom level are preserved — you do not lose your current view.

When the DocsPanel closes:

  1. The map canvas expands back to full width.
  2. The viewport adjusts again to fill the available space.
tip

If you find the map too small with the DocsPanel open, you can open the documentation in a separate browser tab using the external link button in the DocsPanel header. Note that Tutorial Action Links only work inside the DocsPanel — they will not trigger app actions in a separate tab.

Simultaneous interaction​

You can interact with both the map and the docs panel at the same time:

  • Follow a tutorial — Read step-by-step instructions in the docs while performing actions on the map.
  • Click action links — Tutorial Action Links in the docs trigger live actions in the app (search, fly-to, open panels) without leaving the docs page.
  • Search and read — Start a search from the docs, then switch focus to the map to explore results, then come back to the docs for the next step.
  • Compare information — View point details on the map while reading the relevant documentation about metadata fields or jurisdiction-specific data.

Workflow example​

Here is a typical workflow combining the map and docs:

  1. Open the docs panel to read a tutorial.
  2. Click a Tutorial Action Link to focus the search bar and pre-fill a query.
  3. Press Enter to search — results appear in the sidebar, temporarily replacing the docs.
  4. Click a result to view the mark on the map.
  5. Reopen the docs panel to continue reading the next step.

This back-and-forth between docs and map features is the intended workflow for interactive tutorials.

Panel switching​

The DocsPanel shares sidebar space with other panels (search results, point details, Ledger, AI analysis). When you open another panel, the docs panel is replaced. To return to the docs, use the docs toggle button in the header or click the link below.

The link below opens the docs panel if it is not already visible.

Open the docs panel

What you learned​

  • How the map and DocsPanel share screen space
  • How the map automatically resizes when the DocsPanel opens or closes
  • How to interact with both the map and documentation simultaneously
  • How panel switching works between docs and other sidebar panels

Next steps​

Explore the other tutorials to practice using the map and docs together:

Was this page helpful?