Skip to main content

Using the Docs Panel

The DocsPanel lets you read this documentation without leaving the Benchmrk app. It opens as a panel alongside the map, so you can follow guides and interact with the app at the same time.

Opening the DocsPanel​

  1. Look for the Docs toggle button in the header bar (typically a book or help icon).
  2. Click the button to open the DocsPanel on the right side of the screen.
  3. The documentation site loads inside the panel.

The map canvas resizes to make room for the DocsPanel, so both the map and the docs are visible simultaneously.

Inside the DocsPanel, you can browse the documentation just like a regular website:

  • Use the sidebar navigation to jump between sections (Getting Started, Deep Dive, Tutorials, Troubleshooting, Glossary).
  • Use the previous/next links at the bottom of each page to move through a section sequentially.
  • Use the search functionality to find specific topics.

Interactive tutorials​

The DocsPanel is especially useful for the Tutorials section. Tutorial pages contain interactive Tutorial Action Links that can drive the app directly. When you click one of these links inside the DocsPanel, it triggers an action in the app — such as focusing the search bar, flying to a location, or opening a panel.

This means you can learn by doing: read a step, click the action link, see the result in the app, and continue to the next step.

tip

For the best learning experience, open the DocsPanel and follow the tutorials. The interactive links only work when the docs are loaded inside the app.

Closing the DocsPanel​

Click the Docs toggle button again (or the close button on the panel) to hide the DocsPanel. The map expands back to full width.

Opening docs in a new tab​

If you prefer to read the documentation in a separate browser tab, look for the external link button in the DocsPanel header. This opens the docs site in a new tab.

info

Interactive Tutorial Action Links only work when the docs are loaded inside the DocsPanel. They will not trigger app actions when viewed in a standalone browser tab.

Was this page helpful?