libigl / libigl/libigl.github.io

Tutorial reorganization

Open
#44 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
5
Forks
31
PR merge metrics
No merged PRs in 30d

Description

Chapter 7 is getting a bit out of control. Meanwhile, Chapter 1 is simultaneously an intro chapter and a "viewer features" chapter. Let's use this issue to discuss some reorganization. For reference, here're the current tutorial entries (that we have code for; so this includes ones that have missing documentation):

Tetgen
FastAutomaticSkinningTransformations
SignedDistance
MeshImplicitFunction
SweptVolume
BiharmonicDeformation
Boolean
GaussianCurvature
ExplodedView
SLIM
HarmonicParam
NRosyDesign
ViewerMenu
CSGTree
AsRigidAsPossible
Events
ScreenCapture
BoundedBiharmonicWeights
CurvatureDirections
MarchingCubes
LaplaceEquation
Decimation
LSCMParam
MEX
ShapeUp
Planarization
AmbientOcclusion
Laplacian
WindingNumber
Statistics
Gradient
GeodesicDistance
BiharmonicCoordinates
Kelvinlets
SCAF
MultipleViews
Triangle
DirectDeltaMush
FileIO
IterativeClosestPoint
FastWindingNumber
MIQ
DualQuaternionSkinning
Picking
MultipleMeshes
MarchingTets
DrawMesh
ARAPParam
Colors
EigenDecomposition
Matlab
Slice
QuadraticProgramming
FacetOrientation
Overlays
Sort
FrameField
BlueNoise
LinearEqualityConstraints
Normals
Subdivision
DataSmoothing
HeatGeodesics
ImGuizmo
PolyharmonicDeformation
Serialization

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the current Chapter 1 and Chapter 7 tutorial organization alongside the listed tutorial entries. Determine a proposed grouping for the entries and document the agreed reorganization; done means the chapter structure and tutorial placement have been settled and updated.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.