mirror of
https://github.com/bherbruck/solidcraft.git
synced 2026-11-05 19:45:54 +00:00
Victor Santos Oliveira
91638cb1f3
* claim: #5237 command-level guide follow-up * docs: add practical command guides and resource contributions (#5237) * docs: index practical guides and reject incomplete command links
40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
One sentence explaining what this command does and when someone would use it.
|
|
|
|
#### Before you start
|
|
|
|
- Explain the required body, sketch, region, edge, face or point in ordinary words.
|
|
- State whether a selection is required and what cannot be used instead.
|
|
|
|
#### Options
|
|
|
|
| Choice in the dialog | Meaning | Example or reason to choose it |
|
|
| --- | --- | --- |
|
|
| Replace with a real option | Explain the effect without copying parameter syntax. | A useful value with units. |
|
|
|
|
#### Try it
|
|
|
|
1. Start from a small reproducible design.
|
|
2. Name the selection, command, settings and expected visible result.
|
|
|
|
#### Tips and common mistakes
|
|
|
|
- **Do** explain a useful habit and its benefit.
|
|
- **Don't** describe an unsupported selection as if it worked.
|
|
|
|
#### Examples and community resources
|
|
|
|
Add only rows for resources you have checked. Replace placeholders before
|
|
submitting; do not publish an empty resource table.
|
|
|
|
| Kind | Resource and what it teaches | Author and licence |
|
|
| --- | --- | --- |
|
|
| Tip | Link to a focused explanation. | Credit and permission to reuse. |
|
|
| Demo | Link to a short recording or reproducible recipe. | Credit and licence. |
|
|
| Model | Link to an original SolidCraft design or an openly licensed model. | Credit and licence. |
|
|
| Screenshot | Link to or embed an actual SolidCraft result, with descriptive alternative text. | Credit and licence. |
|
|
|
|
#### See also
|
|
|
|
Use `{{#command solid.extrude}}` with a real related command's ID and explain
|
|
why it is related. The generator supplies its current label and a direct link.
|