docs

best_fence Documentation

This directory contains project documentation, including both hand-written guides and generated API documentation.

Documentation Structure

Hand-Written Documentation

• assembly_instructions.md - Step-by-step assembly guide
• bom.md - Bill of materials (parts and hardware)

Generated Documentation

• api/ - Auto-generated API documentation from source files
  • Generated by running make docs
  • Uses openscad_docsgen to extract documentation from code comments
  • Recreated each build, do not edit manually

Updating Documentation

To update hand-written docs:

1. Edit the scad files
2. run make docs
3. Commit changes to version control

To regenerate API docs:

make docs

This will scan all documented functions and modules in:

• assemblies/*.scad
• hardware/*.scad
• parts/*.scad
• tools/*.scad

Documentation Format

Use openscad_docsgen format for documenting functions and modules:

// Module: my_module
// Usage:
//   my_module(size);
// Description:
//   Creates a component with the specified size
// Arguments:
//   size = The size in millimeters
// Example(3D): Standard size
//   my_module(10);
module my_module(size) {
    cube([size, size, size]);
}

See: https://github.com/BelfrySCAD/openscad_docsgen

Adding New Documentation

For assembly steps:

Edit assembly_instructions.md

For parts list:

Edit bom.md

For code documentation:

Add comments to your .scad files and run make docs