List of suggested improvements and corrections for the tutorials

[aguenette]

Corrections

Broken links

Here I'll list all the broken links that I've found so far in the tutorials from readthedocs.org page only. All the links that reference to the source files in the GitHub repo need to be fixed by specifying a complete address, not just a relative path like it's the case right now.

I'll keep it updated as more of them will be found, but also fixed.

• [x] All the "Edit on GitHub" links in the navigation bar doesn't work.

• [x] The "How to use libpointmatcher in ROS?", "Example: Configure an ICP solution without yaml" and "See the example align_sequence.cpp" links from the Tutorials - Advanced menu.

• [x] The "in-memory API" link from the What is libpointmatcher about? section.

• [x] The "Kinect" link in the Simple Sensor Noise Filter - Description from the What the different data filters do? section.

• [x] The "examples/cmake_demo/convert.cpp" link from the Applying Data Point Filters - Overview section.

• [x] The "examples/data/default-convert.yaml" link from the Applying Data Point Filters - Configuring the Data Filters Chain section.

• [x] The "examples/icp_tutorial/cloud_0.vtk", "examples/icp_tutorial/cloud_1.vtk", "examples/icp_tutorial/icp_tutorial_empty.yaml" and "examples/icp_tutorial/icp_tutorial_cfg.yaml" links from the An Introduction to ICP Registration - Visualizing a Point Cloud in Paraview section.

• [x] The "examples/data/default.yaml" link from the Creating Custom Configurations with YAML - Where To Go From Here section.

• [x] The "own file format" link from the Importing and Exporting Point Clouds - Point Cloud Library File Format (PCD) Files section.

• [x] The "pointmatcher/IO.cpp" link from the Supported file types and importing/exporting point clouds - Note For libpointmatcher Developers section.

• [x] The "Boost" link from the Compiling and Installing libpointmatcher on your Computer - Detailed Installation Instructions and Compiling and Installing libpointmatcher on your Computer (Mac OS X Instructions) - c. Installing Boost sections.

• [x] The "Doxygen" link from the Compiling and Installing libpointmatcher on your Computer - 4. Compiling the Documentation (optional) and Compiling and Installing libpointmatcher on your Computer (Mac OS X Instructions) - 2. Compiling the Documentation (optional) sections.

• [ ] The "kwill" link from the Compiling and Installing libpointmatcher on Windows - Special Thanks section. The link is not broken, but it doesn't look like it's the good person.

• [x] The "./examples/demo_cmake" link from the Linking Projects to libpointmatcher - Option 1: Using CMake (Recommended) section.

• [x] The "./examples/demo_Qt" link from the Linking Projects to libpointmatcher - Option 3: Using Eclipse section.

• [x] The "examples/icp_simple.cpp" link from the Writing a program which performs ICP - Overview section.

• [x] The "pointmatcher/DataPointsFilters/" link from the Creating a DataPointsFilter - Generic procedure section.

• [x] The "pointmatcher/DataPointsFilters/" and "pointmatcher/DataPointsFilters/VoxelGrid.h" links from the Creating a DataPointsFilter - Implementation as a DataPointsFilter - Declaration section.

• [x] The "pointmatcher/DataPointsFilters/VoxelGrid.cpp" and "CMakelists.txt" links from the Creating a DataPointsFilter - Implementation as a DataPointsFilter - Implementation of the Filter section.

• [x] The "pointmatcher/DataPointsFiltersImpl.h" and "pointmatcher/Registry.cpp" links from the Creating a DataPointsFilter - Registering the Filter as a Libpointmatcher Module section.

• [x] The "pointmatcher/DataPointsFilters/MaxDist.h" and "pointmatcher/DataPointsFilters/MaxDist.cpp" links from the Creating a DataPointsFilter - Where To Go From Here section.

• [x] The "pointmatcher/Registry.cpp" link from the Extending libpointmatcher Transformations - Making a Custom Transformation a libpointmatcher Module section.

• [x] The "utest/utest.cpp" link from the Testing libpointmatcher Modules section.

• [x] The "this primer" link from the Testing libpointmatcher Modules section doesn't link to the Googletest Primer page, but to the main repo page.

• [x] The "examples/data/icp_data/" and "Configurations from YAML" links from the Testing libpointmatcher Modules - Generic tests section.

• [x] The "next" button from the Linking Projects to libpointmatcher page. It should link to the Using libpointmatcher in ROS page, but it doesn't exist.

• [x] The body's Tutorials Home button from the Writing a program which performs ICP, Applying Transformations to Point Clouds, Extending libpointmatcher Transformations and the Testing libpointmatcher Modules pages.

Navigation

• [x] On the Datapoint Filters page, the navigation bar's previous button doesn't link to the same tutorial page then the body's previous button. The first one links to the Applications and Publications page while the other one links to the Compiling and Installing libpointmatcher on your Computer page. I suggest that both of them link to the Applications and Publications page.

• [x] On the Applying Data Point Filters page, the navigation bar's next button doesn't link to the same tutorial page then the body's next button. The first one links to the An Introduction to ICP Registration page, which is correct, while the other one links to the Writing a program which performs ICP page, which is not correct, because it's an advanced tutorial page.

• [x] On the Creating Custom Configurations with YAML page, the body's previous button doesn't link to the right tutorial page. It links to the Writing a program which performs ICP page, which is an advanced tutorial's page, instead of linking to the Default Configuration of the ICP Chain page.

• [x] On the Importing and Exporting Point Clouds page, the body's next button links to the Linking Projects to libpointmatcher page, which is an advanced tutorial's page, instead of linking to the Compiling and Installing libpointmatcher on your Computer page.

• [x] On the Compiling and Installing libpointmatcher on your Computer page, the body's next button links to the Datapoint Filters page, instead of linking to the Compiling and Installing libpointmatcher on Windows page. Also, there's no previous button on the page's body that should link to the Importing and Exporting Point Clouds page.

• [x] On the Compiling and Installing libpointmatcher on Windows page, the body's next button links to the Datapoint Filters page, instead of linking to the Compiling and Installing libpointmatcher on your Computer (Mac OS X Instructions) page. Also, there's no previous button on the page's body that should link to the Compiling and Installing libpointmatcher on your Computer page.

• [x] On the Compiling and Installing libpointmatcher on your Computer (Mac OS X Instructions) page, the body's next button links to the Datapoint Filters page, instead of linking to the Linking Projects to libpointmatcher page. Also, there's no previous button on the page's body that should link to the Compiling and Installing libpointmatcher on Windows page.

• [x] On the Linking Projects to libpointmatcher page, the body's previous button links to the Creating Custom Configurations with YAML page, instead of linking to the Compiling and Installing libpointmatcher on your Computer (Mac OS X Instructions) page. Also, the navigation bar's next button should link to the Using libpointmatcher in ROS page (the page doesn't exist, see the broken links section), instead of linking to the Point Clouds in Libpointmatcher page.

• [x] On the Point Clouds in Libpointmatcher page, the body's next button should link to the Writing a program which performs ICP page, instead of linking to the Applying Transformations to Point Clouds page. Also, the navigation bar's previous button should link to the Using libpointmatcher in ROS page (the page doesn't exist, see the broken links section), instead of linking to the Linking Projects to libpointmatcher page.

• [x] On the Applying Transformations to Point Clouds page, the body's previous button should link to the Writing a program which performs ICP page, instead of linking to the Point Clouds in Libpointmatcher page. Also, both body's and navigation bar's next buttons should link to the Example of an ICP solution without yaml page (the page doesn't exist, see the broken links section), instead of linking to the Creating a DataPointsFilter page.

• [x] On the Testing libpointmatcher Modules page, the body's next button links to itself, but it shouldn't be there.

Improvements suggestions

• [x] In the Linking Projects to libpointmatcher - Option 1: Using CMake (Recommended) section, the CMake example should be updated to match with the CMakeLists.txt file that is in the examples/cmake_demo folder.

• [x] In the Linking Projects to libpointmatcher - Option 2: Using Eclipse section, the suggested project configuration doesn't compile when we try to build the project, because the compiler doesn't find the eigen3 library. To fix this, the eigen3 library must be added alongside the libpointmatcher library in the project configuration (Project > Properties > C/C++ build > Settings then GCC C++ Compiler > Includes and add /usr/include/eigen3 to the Include paths (-l) list).

• [x] In the Creating Custom Configurations with YAML - Configuration of an ICP Chain section, more emphasis needs to be put on the syntax difference to be used between a module that accepts only one filter from a module that accepts a list of filters.

• [x] In the list of modules and filters from the Creating Custom Configurations with YAML - Configuration of an ICP Chain section, it would be really nice that each filters links to their reference at the Datapoint Filters page.