grafana / grafana/interactive-tutorials

Empower writers to build Pathfinder in-product assistance

Open
#404 0 comments 0 reactions 1 assignee Claimed by @tacole02 View on GitHub
Dominant language
HTML
Stars
13
Forks
8
Avg merge
2d 4h
Merged PRs (30d)
45

Description

## Overview

This epic tracks work to make Pathfinder authoring easier for writers.

## Goals

- Make Pathfinder authoring more approachable for doc writers
- Shorten the path from concept to published guide
- Improve consistency and quality across teams
- Support the full lifecycle: authoring, validation, targeting, and maintenance

## Scope

1. **Authoring tools:** block editor, shared snippets, guide templates
2. **Writer docs:** how to write `content.json` and `manifest.json`, pick selectors, and structure guides
3. **Quality checks:** `/lint` and `/check` that writers run locally and in CI
4. **Guide targeting:** manifests and recommender rules so guides appear on the right Grafana pages

## Success criteria

- A doc writer with no prior Pathfinder experience can create a guide, pass lint/check, and merge a PR using repo docs only
- Repo docs cover the full workflow: structure a guide, pick selectors, write a manifest, validate locally, open a PR
- Validation catches the errors that currently slow down PR review: bad selectors, missing requirements, schema violations

## Related repos

- [interactive-tutorials](https://github.com/grafana/interactive-tutorials)
- [grafana-recommender](https://github.com/grafana/grafana-recommender) (no longer required with packaging format)
- [website](https://github.com/grafana/website)

## Child issues

Link scoped work as sub-issues of this epic.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.