Skip to content

Conventions

← All terms · Orbit-internal concepts

Also called Conventions panel

A panel that renders the global `workflow.md` file as formatted HTML with a TOC and search. Acts as Orbit's central in-app convention reference.

What it is

Conventions renders the full workflow.md as formatted HTML with a TOC sidebar, real-time search, and "Why" reasoning blocks shown in a distinct indented style. Displays a Custom or Default badge depending on whether `~/.orbit/global/workflow.md` exists. Includes a Reset intro button that re-triggers the post-onboarding welcome modal. All (?) help icons throughout Orbit deep-link to relevant sections here.

When you would use it

You open Conventions when you want to look up something specific to Orbit's expected workflow, or when help links anywhere in Orbit point you here.

Common operations

  • Looking up Orbit conventions while working
  • Customizing workflow.md for personal patterns
  • Resetting the onboarding intro modal

Related terms

Dashed terms are named in the source but do not have a page here yet.

Where this is taught

No learning path uses this term yet. Browse the Learning Atlas for guided sequences through related ideas.