Skip to content

Add README.md documentation to all AliceVision modules#2087

Open
Copilot wants to merge 2 commits intodevelopfrom
copilot/add-readme-to-alicevision-modules
Open

Add README.md documentation to all AliceVision modules#2087
Copilot wants to merge 2 commits intodevelopfrom
copilot/add-readme-to-alicevision-modules

Conversation

Copy link
Contributor

Copilot AI commented Mar 18, 2026

Description

Each module under src/aliceVision previously lacked inline documentation. This PR adds a README.md to every module that was missing one, following the style established by camera/ and feature/.

Features list

  • Add README.md to 31 modules: calibration, cmdline, colorHarmonization, dataio, depthMap, featureEngine, fuseCut, gpu, graph, hdr, imageMasking, imageMatching, imageProcessing, lensCorrectionProfile, lightingEstimation, matchingImageCollection, mesh, mvsData, mvsUtils, panorama, photometricStereo, python, segmentation, sensorDB, sfmDataIO, sfmMvsUtils, sphereDetection, stl, system, utils, voctree

Implementation remarks

Each README covers:

  • Purpose/overview of the module in the reconstruction pipeline
  • Key classes and their roles (derived from header file documentation)
  • Code examples where the API warrants illustration
  • References to relevant papers where the algorithm has a published basis (e.g. Debevec CRF, Nistér vocabulary tree, Labatut graph-cut)

Existing READMEs (camera, feature, geometry, image, keyframe, linearProgramming, matching, multiview, numeric, robustEstimation, sfm, sfmData, track) were left unchanged.


💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

…ng documentation

Co-authored-by: fabiencastan <153585+fabiencastan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add README.md to each alicevision module without existing documentation Add README.md documentation to all AliceVision modules Mar 18, 2026
Copilot AI requested a review from fabiencastan March 18, 2026 16:04
@fabiencastan fabiencastan added this to the 3.4.0 milestone Mar 18, 2026
@fabiencastan fabiencastan marked this pull request as ready for review March 18, 2026 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants