Skip to content

Getting started button

github-actions[bot] edited this page Oct 14, 2026 · 3 revisions

lang: en

Language: English · Русский

Getting started button

The Getting started button opens the welcome window. The same window appears by itself the first time Revit starts after Revit Linter is installed.

The window has five steps:

  1. Welcome — what the add-in does, the workflow Revit model → Diagnostics → Findings → Show or fix → Export report, and the name of its ribbon tab.
  2. Diagnostics — compares built-in diagnostics with user-defined YAML rules and shows the main fields of a rule in a read-only example.
  3. Examples — pick the disciplines you work with (MEP systems, architecture, structure) and press Load examples. The example configurations are written to the configuration folder of the running Revit version.
  4. Practical tour — starts or continues the Practical tour. If no document is open, this step can prepare a disposable copy of an official Autodesk sample found for the running Revit version, or let you continue with your own document.
  5. Done — a short completion summary with links to the quick start, documentation, and support.

Note

Loading examples always writes to the examples subfolder of the configuration folder; your own files are never touched. Copy the rules you need from there into your own configuration files.

The window is shown automatically once per user. The Examples step is offered once for every Revit version, because each version has its own configuration folder. Closing the window in any way counts as shown; the button always opens the complete introduction.

Practical-tour progress is also stored per Revit version. Reset practical tour clears only that progress; it does not remove installed examples or reset whether the welcome window was shown.

← Ribbon buttons

Clone this wiki locally