Tutorials

Tutorials

Tutorials are the project's guided onboarding path. They are designed for new contributors who need to build a working mental model through hands-on outcomes before using the task-oriented how-to guides or the detailed reference pages.

When to Use This Category

Use a tutorial when you are asking:

• "How do I get oriented in this codebase for the first time?"
• "Can I run the prototype and observe real behavior before reading source code?"
• "How do I learn the documentation workflow by completing a small change?"

If you already understand the system and need to complete a job, use How-To Guides instead.

Tutorial Curriculum (Recommended Order)

1. Tutorial: Run the Prototype Locally
   • Outcome: you start the local browser prototype and exercise the shell and deep-link behavior.
2. Tutorial: Trace a Desktop Action End to End
   • Outcome: you can follow a real flow across site, desktop_runtime, and platform/storage layers.
3. Tutorial: First Documentation Change
   • Outcome: you can make a small docs change using the wiki + rustdoc + docs/ artifact model.

What Tutorials Cover (and What They Do Not)

Tutorials in this wiki:

• are linear and finishable
• prioritize momentum over completeness
• introduce concepts only as needed to keep the reader moving
• point to Explanations and Reference for deeper detail
• use the shared instructional template (Outcome, Entry Criteria, Procedure, Validation, Next Steps)

Tutorials do not:

• serve as exhaustive command catalogs
• replace operational runbooks or SOPs
• document every API, module, or crate surface

After Completing the Tutorials

Next, read Explanations in order to understand the architecture and design rationale. Then use How-To Guides for day-to-day contribution tasks.