Grafana Pathfinder App
Get help exactly when and where you need it. Grafana Interactive Learning brings contextual documentation and interactive tutorials directly into Grafana, so you can learn and build without leaving your workflow.
Install / Use
npx skills add grafana/grafana-pathfinder-appInstalls into whichever agent you are using.
README
Interactive learning Plugin
Get help exactly when and where you need it. Interactive learning brings contextual documentation and interactive guides directly into Grafana, so you can learn and build without leaving your workflow.
What is Interactive learning?
Interactive learning is your in-app learning companion. It provides:
- Smart recommendations – Get relevant docs and guides based on what you're working on
- Interactive guides – Follow step-by-step guided learning paths with "Show Me" and "Do It" features
- Tab-based navigation – Open multiple docs and guides in tabs, just like a browser
- Milestone tracking – See your progress through learning paths with clear milestones
- Always available – Access help without switching windows or searching documentation sites
How to access Interactive learning
- Look for the Help button (?) in the top navigation bar of Grafana
- Click the Help button to open the Interactive learning panel
- Browse recommended documentation based on your current context
- Click View to read a doc or Start to begin an interactive guide
Getting started
Once you open Interactive learning:
- Review recommendations – See docs and guides tailored to what you're doing in Grafana
- Open content in tabs – Click "View" or "Start" to open content in a new tab
- Navigate guides – Use the milestone navigation at the bottom to move through learning paths
- Try interactive features – Click "Show Me" to see where things are, or "Do It" to have Interactive learning guide you through actions
- Manage your tabs – Close tabs you're done with, or keep them open for reference
Keyboard shortcuts
Alt + Left Arrow– Previous milestoneAlt + Right Arrow– Next milestone
For administrators
Discovering Interactive learning
Users can find Interactive learning in multiple ways:
- Help button – Click the Help (?) button in the top navigation
- Command palette – Search for "Interactive learning", "Need help?", or "Learn Grafana" in the command palette (
Cmd+KorCtrl+K)
Configuration options
Admins can configure Interactive learning from the plugin's configuration page in Grafana. The configuration includes three sections:
1. Configuration (basic settings)
- Auto-launch guide URL – Set a specific learning path or documentation page to automatically open when Grafana starts (useful for demos and onboarding)
- Global link interception – (Experimental) When enabled, clicking documentation links anywhere in Grafana will open them in Interactive learning instead of a new tab
2. Recommendations
- Context-aware recommendations – Enable/disable recommendation service that provides personalized documentation based on your current actions in Grafana
- Data usage controls – Review what data is collected and toggle the feature on or off
3. Interactive features
- Auto-completion detection – (Experimental) Enable automatic step completion when users perform actions themselves (without clicking "Do it" buttons)
- Timing settings – Configure timeouts for requirement checks and guided steps to optimize the guide experience
Creating interactive guides
Editors and admins can author custom interactive guides in two ways:
- In the block editor inside Grafana — open the Editor tab in the Pathfinder docs panel. No JSON required; the editor handles save, draft, publish, and update for you. See the Block editor user guide.
- By writing JSON directly — for guides that ship in the plugin bundle or are versioned in git.
Documentation
- JSON Guide Format Reference — Complete reference for the JSON guide structure and all block types (markdown, image, video, section, conditional, interactive, multistep, guided, code-block, terminal, terminal-connect, grot-guide, quiz, input, assistant)
- Interactive Types — Action types (
highlight,button,formfill,navigate,hover,noop,popout) and when to use each - Requirements Reference — Available requirements for controlling when interactive elements are accessible
- Selectors Reference — How to target DOM elements with the enhanced selector engine and the resilience pipeline
See the JSON Guide Demo for a complete example of all block types.
For developers
If you're new to the codebase, start at docs/developer/GETTING_STARTED.md for the five-minute quickstart and first-week reading list. The full developer doc index lives in AGENTS.md.
Contributing
We welcome feedback, issues, and contributions. See CONTRIBUTING.md for how to get set up, what we look for in a pull request, and how to keep changes easy to review.
License
See CHANGELOG.md for details on project changes and license information.
Related Skills
mcp
Use the `mcp_perplexity-ask_perplexity_search` tools to answer questions. You should use this instead of the `web_search` tool because it is a lot more accurate.
practical-power-systems-synthesis
This skill enables synthesis in the domain of power-systems (engineering). It represents research-level-level expertise and is designed for production use in research, industry, and educational contexts. Use this skill when you need to perform synthesis operations related to power-systems.
semi-supervised-optogenetics-testing
This skill enables testing in the domain of optogenetics (neuroscience). It represents intermediate-level expertise and is designed for production use in research, industry, and educational contexts. Use this skill when you need to perform testing operations related to optogenetics.
data-mining-interpretation-fundamental
This skill enables interpretation in the domain of data-mining (data-science). It represents fundamental-level expertise and is designed for production use in research, industry, and educational contexts. Use this skill when you need to perform interpretation operations related to data-mining.
