Docs
Tutorial

Where next

What to read once you've finished the tutorial, and where to start on your own designs.

You've done everything Designs does: connected a NetBox, added designs to the catalogue, planned and applied them, deployed one design several times, changed a design and watched the deletes reach NetBox, caught drift, managed several designs under one name, planned into a branch, and torn it all down in the right order.

Write your own designs

Write your own designs covers how to start a design from scratch or from something NetBox already has, how to check it before you add it, and how to have an AI assistant write it with you. The tutorial's three designs are a good scaffold: the regions show nesting, the site shows variables and references, and the rack shows composition, loops and functions.

How it works

Concepts explains what the tutorial did:

  • How Designs works: render, plan, review, apply, and what a design owns.
  • Composition: building designs from other designs and the Device Type Library.
  • Variables: how a design takes input and passes it on.
  • Functions: how the rack's cables found their ports.
  • Deployments: created and adopted, and what each action does.

When you need a specific thing

The how-to guides are the tutorial's steps without the story, for when you're in the middle of something: edit a design, plan into a branch, check for drift, and read a plan, which lists every warning a plan can show and every reason one is refused.

Everything a design can say

Reference lists the parts of a design, the object types it can build and the key each is matched by, expressions, functions, and what Designs doesn't do yet.

On this page