Add docs page for switching from other geometry libraries - #6664
Merged
Conversation
Developers evaluating MeshLib usually arrive with an existing CGAL, libigl, Open3D, PCL or VTK pipeline and their first question is how their current calls map onto MeshLib. The docs had no single place answering that, so every such question was handled ad hoc. The page pairs the most frequently ported operations - boolean, decimate, signed distance, ICP, surface reconstruction, sampling, normals, mesh IO - with the equivalent MeshLib code, plus an in-memory numpy bridge for VTK users in Python. Placed as a top-level menu item between Examples and Package Overview so it is reachable without knowing our terminology.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a top-level documentation page Switching from Other Libraries to MeshLib (
meshlib.io/documentation/SwitchingFromOtherLibraries.html).Developers evaluating MeshLib usually arrive with an existing CGAL / libigl / Open3D / PCL / VTK pipeline, and their first question is how their current calls map onto ours. The docs had no page answering that. This one pairs the most frequently ported operations with the equivalent MeshLib code:
Two files:
doxygen/general_pages/SwitchingFromOtherLibraries.dox— the page (23 code blocks, no images).doxygen/layout_templates/base_struct.xml— one nav entry, top-level, between Examples and Package Overview.Notes for review:
source/(includes, signatures,Expected/optionalhandling). Competitor snippets are illustrative and are not built by CI — that is the same trade-off the page's copy makes explicit ("copy, adapt, compile").SwitchingFromOtherLibraries.htmlalso needs a line inwhitelist.txtofMeshInspector/MeshInspector.github.io(the rest of the docs isgooglebot: noindex). Not part of this repo — flagged separately.Test plan
Built the Main docs module locally with doxygen against this branch and against
origin/master, using the realDoxyfileMainfromMeshInspector.github.io:SwitchingFromOtherLibraries.htmlis generated; title, all 6 library sections and 13 sub-sections appear in the page TOC; 23 code blocks render.menudata.js(top menu) andnavtreedata.js(sidebar) pointing atSwitchingFromOtherLibraries.html.