three-bvh-csg icon indicating copy to clipboard operation
three-bvh-csg copied to clipboard
verified publisher icon gkjohnson

Improve documentation

Open gkjohnson opened this issue 3 years ago • 3 comments

Add more publicly documented classes, parameters, demos, example snippets.

Classes to document:

  • Evaluator.debug & OperationDebugData
  • Evaluator.evaluateHierarchy
  • Operation & OperationGroup
  • GridMaterial
  • PointsHelper, HalfEdgeHelper, EdgesHelper, TriangleSetsHelper

gkjohnson avatar Sep 08 '22 20:09 gkjohnson

Hi @gkjohnson, do you want to create a documentation like the three-mesh-bvh README.md file?

AngyDev avatar Sep 11 '22 09:09 AngyDev

Yeah that would be perfect - the docs that are there should already be structured a bit similarly in this project, too. Hopefully the documentation structure is self-explanatory but if not feel free to ask questions!

gkjohnson avatar Sep 11 '22 22:09 gkjohnson

Ok I try, let's see what I can do 😊

AngyDev avatar Sep 12 '22 17:09 AngyDev