Markdown Documentation Index¶

This file is automatically generated by scripts/generate_md_index.py. It provides a complete index of all Markdown documentation available in the repository.

.github¶

Copilot Instructions — milk (copilot-instructions.md)

Root¶

Agent Onboarding — milk (AGENTS.md)
Contributing to milk (CONTRIBUTING.md)
Project: milk (GEMINI.md)
Milk (README.md)

docs¶

FPS Standalone and CMD Modes (FPS_Standalone_CMD_Modes.md)
Software Architecture (architecture.md)
Code Assist Tools (code_assist.md)
Debugging (debugging.md)
Dependency Graph (dependency_graph.md)
FAQ & Troubleshooting (faq.md)
Function Processing System (FPS) (fps.md)
Milk Documentation (index.md)
Performance Tuning (performance.md)
Profile-Guided Optimization (PGO) & Link-Time (pgo.md)
Process Info (procinfo) (procinfo.md)
Programmer's Guide to milk (programmers_guide.md)
Python API (python.md)
Scripts Reference (scripts.md)
Shared Memory Streams (ImageStreamIO) (streams.md)
Tags (tags.md)
Valkey Integration (valkey.md)

docs/cli¶

CLI Overview (CLI_Overview.md)
Command Line Interface Syntax (CLIcore.md)
Readline Input Keys (helpreadline.md)

docs/developer¶

Documenting Code (DocumentingCode.md)
Loading, Creating Additional Modules (LoadingModules.md)
Module Files (ModuleFiles.md)
Template Source Code (TemplateSourceCode.md)
Working with git (WorkingWithGit.md)
Coding Standards (coding_standards.md)
Adding a Plugin to Milk (plugins.md)
Developer Tutorial: Writing Your First Milk Module (tutorial.md)

docs/install¶

Build Tiers (build_tiers.md)
Installation (compile.md)

milk-examples¶

Milk Examples (README.md)

milk-examples/example01_ImageStreamIO¶

Example 01: ImageStreamIO (README.md)

milk-examples/example02_processinfo¶

Example 02: ImageStreamIO + ProcessInfo (README.md)

milk-examples/example03_fps¶

Example 03: ImageStreamIO + ProcessInfo + FPS (README.md)

plugins/milk-extra-src/ZernikePolyn¶

Module: ZernikePolyn (README.md)

plugins/milk-extra-src/clustering¶

Module: clustering (README.md)

plugins/milk-extra-src/fft¶

Module: fft (README.md)

plugins/milk-extra-src/image_basic¶

Module: image_basic (README.md)

plugins/milk-extra-src/image_filter¶

Module: image_filter (README.md)

plugins/milk-extra-src/image_format¶

Module: image_format (README.md)

plugins/milk-extra-src/image_gen¶

Module: image_gen (README.md)

plugins/milk-extra-src/img_reduce¶

Module: img_reduce (README.md)

plugins/milk-extra-src/info¶

Module: info (README.md)

plugins/milk-extra-src/kdtree¶

Module: kdtree (README.md)

plugins/milk-extra-src/linARfilterPred¶

Module: linARfilterPred (README.md)

plugins/milk-extra-src/linalgebra¶

Module: linalgebra (README.md)

plugins/milk-extra-src/linopt_imtools¶

Module: linopt_imtools (README.md)

plugins/milk-extra-src/psf¶

Module: psf (README.md)

plugins/milk-extra-src/statistic¶

Module: statistic (README.md)

python_module¶

CacaoProcessTools (README.md)

src/cli/CLIcore¶

CommandLineInterface Change Log {#page_CommandLineInterface_ChangeLog} (CHANGELOG.md)
CLIcore (README.md)

src/cli/libmilkTUI¶

Module: libmilkTUI (README.md)

src/coremods/COREMOD_arith¶

Module: COREMOD_arith (README.md)

src/coremods/COREMOD_iofits¶

Module: COREMOD_iofits (README.md)

src/coremods/COREMOD_memory¶

Module: COREMOD_memory (README.md)

src/coremods/COREMOD_tools¶

Module: COREMOD_tools (README.md)

src/engine/libfps¶

Module: libfps (README.md)

src/engine/libmilkdata¶

Module: libmilkdata (README.md)

src/engine/libprocessinfo¶

libprocessinfo: MILK Process Management Library (README.md)

src/fpsvalkey¶

milk-fps-valkey — FPS Parameter Sync to Valkey (README.md)

src/isio-tools¶

isio-tools (README.md)

src/milk_module_example¶

Module: milk_module_example (README.md)