Improve documentation - Githubissues

gkjohnson / three-bvh-csg

A flexible, memory compact, fast and dynamic CSG implementation on top of three-mesh-bvh

MIT License

601 stars 46 forks source link

Improve documentation #72

Open gkjohnson opened 2 years ago

gkjohnson commented 2 years ago

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

Classes to document:

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

AngyDev commented 2 years ago

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

gkjohnson commented 2 years ago

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!

AngyDev commented 2 years ago

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