Skip to content

docs: add Skinning/Sweeping and Edge/Face Sets tutorials (#89)#1960

Merged
revarbat merged 5 commits into
BelfrySCAD:masterfrom
junhinhow:docs/tutorials-89
May 11, 2026
Merged

docs: add Skinning/Sweeping and Edge/Face Sets tutorials (#89)#1960
revarbat merged 5 commits into
BelfrySCAD:masterfrom
junhinhow:docs/tutorials-89

Conversation

@junhinhow
Copy link
Copy Markdown
Contributor

Summary

  • Add Skinning.md tutorial (225 lines): covers skin(), path_sweep(), spiral_sweep() with practical examples
  • Add Edge_Face_Sets.md tutorial (254 lines): covers edge/face selection, EDGES constant, except parameter, masking patterns

Both tutorials follow existing BOSL2 tutorial format with progressive examples from simple to complex.

Test plan

  • All OpenSCAD code examples in tutorials are valid
  • Markdown renders correctly
  • Links to existing documentation are accurate

Addresses #89

🤖 Generated with Claude Code

New tutorial covering:
- What is skinning (connecting 2D cross-sections)
- skin() basic usage with multiple profiles
- path_sweep() along 2D and 3D paths with twist/scale
- spiral_sweep() for helical shapes
- Practical examples: wavy vase, twisted ribbon, pipe along curve

This was one of the 6 missing tutorials listed in issue BelfrySCAD#89.

Ref: BelfrySCAD#89
New tutorial covering:
- Face direction vectors (TOP, BOT, FRONT, BACK, LEFT, RIGHT)
- Single edge selection via face vector pairs (TOP+FRONT)
- Face-based and corner-based edge selection
- Axis-aligned strings ("X", "Y", "Z", "ALL", "NONE")
- Combining selections with lists
- The except parameter for exclusions
- Usage with rounding, chamfering, and masking modules
- Practical examples and quick reference table

This was one of the 6 missing tutorials listed in issue BelfrySCAD#89.

Ref: BelfrySCAD#89
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds two new BOSL2 tutorials intended to document (1) skinning/sweeping workflows and (2) edge/face selection descriptors used across BOSL2 shape + masking APIs.

Changes:

  • Add tutorials/Skinning.md covering skin(), path_sweep(), and spiral_sweep() with progressively more complex examples.
  • Add tutorials/Edge_Face_Sets.md explaining face vectors, edge descriptors, axis-string shortcuts, and exclusion patterns.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
tutorials/Skinning.md New tutorial for generating solids by connecting profiles (skin) and sweeping profiles along paths (path_sweep, spiral_sweep).
tutorials/Edge_Face_Sets.md New tutorial describing how to specify faces/edges for rounding/chamfering and for masking/profile attachment modules.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread tutorials/Edge_Face_Sets.md Outdated
Comment thread tutorials/Edge_Face_Sets.md
Comment thread tutorials/Edge_Face_Sets.md
Comment thread tutorials/Skinning.md Outdated
revarbat added 3 commits May 9, 2026 22:17
Updated the description and formatting of faces and edges in the Edge_Face_Sets documentation. Improved clarity and consistency in the presentation of vector names and examples.
@revarbat revarbat merged commit 40d77a4 into BelfrySCAD:master May 11, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants