A build guide in five steps
A build guide shows other makers how to build something you made: what it is, what to buy and print, and every step to put it together. The editor walks you through five steps, and you can jump between them in any order.
- 1
BasicsName your build, write a one or two sentence summary, and pick a category and difficulty.
- 2
Photos & videoAdd a cover photo of the finished build. A main video is optional.
- 3
Parts & filesList everything a builder needs to buy or print, and attach your STL, 3MF, firmware or other files.
- 4
InstructionsWrite a short introduction, then add numbered build steps with a photo for each.
- 5
PublishCheck the list, choose a licence and submit. The PrintPal team gives it a quick review before it appears on the hub.
Once your build has a title, the draft saves automatically a few seconds after you stop typing. Nobody else can see it until you publish, and you can come back to it any time from My builds.
Before you start
- Gather the photos you took while building. Phone photos are fine.
- Have your model files and any code ready to upload.
- Jot down the parts you used and where you bought them.
Start with an introduction
Say what the build does, why you made it, and what the finished result looks like. Mention any skills it needs, such as soldering or flashing firmware, so readers know what they're signing up for.
Then add your build steps
New guides start with an Introduction section and a Steps section. Inside Steps, click Add step for each stage of the build.
- Give every step a short title that says what to do, like Mount the motor.
- Keep each step to one action, or a few closely related ones.
- Add a photo to each step. Readers follow the pictures more than the text.
- Use the arrow buttons to reorder steps and sections.
Section types
Use Add a section below your instructions to add any of these:
| Section | Use it for |
|---|
| Text | Paragraphs, lists and links. Good for the introduction, background and wiring notes. |
| Steps | Numbered instructions with a photo for each step. The core of most guides. |
| Image | One photo with a caption. |
| Gallery | Several photos in a grid, like the finished build from every angle. |
| Video | A YouTube or Vimeo link, or an uploaded clip. |
| Code | Firmware, scripts or config files, shown with a copy button. |
| Callout | A highlighted box for tips, warnings and safety notes. |
| Divider | A line that separates parts of the guide. |
Give a section a heading and it shows up in the guide's table of contents. To see the guide the way readers will, switch to Split or Preview at the top of the Instructions step.
Cover photo
- Shows on the hub card and at the top of your guide.
- Use a bright, sharp photo of the finished build against a plain background.
- Landscape (16:9) crops best. JPG, PNG, WebP or GIF, up to 12 MB.
- No cover photo? A main video works too, and failing that the first photo in your instructions is used.
Main video
Paste a YouTube or Vimeo link, or upload a video file up to 200 MB. It plays at the top of the guide.
Parts list
- List everything a builder needs, including the parts they print. Set printed parts to 3D printed.
- Set the type to Tool or Software for things they need on hand but don't use up, like a soldering iron or a slicer. Those get their own table.
- Add a buy link where you can, pasted as a full web address (
https://…).
- Already have a list somewhere? Click Paste a list and add one part per line, like
4x M3 x 10 screw.
Files
- Drag files onto the upload box or click it to browse. Each file can be up to 100 MB.
- Accepted: 3D models (STL, 3MF, OBJ, STEP, SCAD, F3D, Blend), print files (G-code, BGCODE, UFP), code and firmware (INO, PY, C/C++, JSON, HEX, UF2, BIN), PCB files (KiCad, Eagle), documents (PDF, TXT, CSV, XLSX) and archives (ZIP, 7Z, TAR).
- Anything else? Put it in a ZIP first.
- Use each file's description for print settings, like 0.2 mm layers, 4 walls, no supports.
Text sections, step instructions and callouts use Markdown, a simple way to format with ordinary characters.
| You type | You get |
|---|
**bold** | bold |
*italic* | italic |
## Wiring | A heading. Use two or three # marks. |
- item | A bulleted list, one item per line |
1. item | A numbered list |
[PrintPal](https://printpal.io) | A link |
`M3 x 10` | Inline code, handy for part numbers and settings |
> note | A quote |
``` … ``` | A block of code, with three backticks on the lines above and below it |
Each new line you type starts a new line in the guide. Leave a blank line between paragraphs.
For longer firmware or scripts, use a Code section instead. It shows the filename and gives readers a copy button.
What a guide needs before you publish
- A title and a short summary
- A cover photo or a main video
- At least two filled-in sections of instructions, including written text or build steps
The Publish step shows this as a checklist, and each missing item links to the place to fix it.
What happens when you submit
- 1
In reviewYour guide is still private while someone from the PrintPal team checks that it's complete and follows the community rules.
- 2
LiveOnce approved, it appears on the hub at /projects and in search results.
- 3
Or: changes requestedIf something needs fixing, you'll get a note explaining what. Update the guide and submit it again.
Status labels
DraftOnly you can see it.
In reviewWaiting for the PrintPal team. You can keep editing.
Changes requestedRead the note, update the guide and submit it again.
LivePublic on the hub and in search.
You'll find every guide and its status on My builds.
Changing a live guide
You can edit a live guide any time, but saving changes takes it off the hub until it's approved again. Make all your edits in one sitting, then save.
To take a guide down, open it in the editor, go to the Publish step and use Move back to drafts. Delete removes the guide and everything uploaded to it for good.
Who can see my draft?
Only you and PrintPal staff. It stays private until it's published.
Why can't I publish yet?
Open the Publish step. The checklist shows what's still missing, and each item links straight to where you fix it.
Can I share a build based on someone else's design?
Yes, if their licence allows it. Credit the original designer and link to their work in your introduction, and only upload files you have the right to share.
Which licence should I choose?
CC BY 4.0 is a good default: anyone can use and remix your design as long as they credit you. Choose CC BY-NC if you don't want others selling it, or MIT / GPL for code. The Publish step explains each option.
Can I edit a guide after it's published?
Yes. Open it from My builds and click Edit. Saving changes to a live guide takes it off the hub until it's approved again.
My upload failed. What now?
Check the size limits: photos up to 12 MB, videos up to 200 MB, and other files up to 100 MB each. If the file type isn't accepted, put it in a ZIP and upload that.
Where do I find my guides later?
My builds lists all of your drafts and published guides, with their status.
inovitek_3d
2233
8
Video
Video
Video
Video
Video
Video