Skip to content

Choose Your Path

This page helps you choose the right section of the documentation once you know you want to work with Pegium, but are not yet sure where to begin.

Start with Introduction if

  • you are still deciding whether Pegium fits your project
  • you want the high-level picture before reading APIs
  • you want the concept mapping first

Useful pages:

Start with Learn if

  • you want the recommended end-to-end workflow
  • you are building your first language with Pegium
  • you prefer a linear path over jumping between API pages

Useful pages:

Start with Recipes if

  • you already know which subsystem you want to customize
  • your question sounds like "How do I...?"
  • you want examples for scoping, validation, caching, or multiple languages

Useful pages:

Start with Reference if

  • you want exact terminology or API-oriented explanations
  • you need to understand how services, documents, or the semantic model fit together
  • you already know the workflow and want canonical subsystem descriptions

Useful pages:

Start with Examples if

  • you learn best from working code
  • you want a template close to your target language
  • you prefer to inspect a complete implementation before reading abstractions

Useful pages:

Quick orientation

Read Introduction to orient yourself, Learn to build something, Recipes to solve targeted tasks, and Reference to confirm exact concepts and APIs.