Add Part 9: Module Reference for bundled modules#296
Merged
Conversation
Back-fill per-module documentation for the ~56 bundled FreeSWITCH modules that the topical chapters did not cover (previously only name-dropped in the module-loading tables). Each value is verified against the module C source and the shipped conf/vanilla configuration. New docs/module-reference/ section (Part 9), grouped by src/mod category: Applications, Endpoints, Dialplan Engines, File Formats, Speech (ASR/TTS), Events/CDR/Logging, Caching and Data Stores, XML Interfaces and Directories, and Embedded Languages, plus consolidated Timers and Say pages. Each page documents purpose, the module load name, its configuration file and parameters, the dialplan applications and API commands it registers, the channel variables it reads or sets, and any custom events. Also: - channel-variables.mdx: add a "Module Reference Variables" index mapping the 125 module-introduced channel variables to their Part 9 pages. - module-loading.mdx: cross-reference the Optional Modules section to Part 9. - appendix-vanilla-config-map.mdx: point 27 optional-module config rows at their Part 9 pages and fix voicemail_ivr.conf.xml (was mis-attributed to mod_voicemail / Chapter 19). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Devon-White
approved these changes
Jun 11, 2026
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
Back-fills per-module documentation for the ~56 bundled FreeSWITCH modules that the topical chapters did not cover — previously these were only name-dropped in the module-loading tables. Every value is verified against the module C source and the shipped
conf/vanilla/configuration, consistent with the manual's existing standard.New section: Part 9 — Module Reference
docs/module-reference/, grouped bysrc/mod/category:mod_say_*)Each page documents: purpose, the module load name and default-load status, its configuration file and parameter table with a real example, the dialplan applications and API commands it registers, the channel variables it reads/sets, and any custom events.
Supporting changes
channel-variables.mdx— new "Module Reference Variables" index mapping the 125 module-introduced channel variables back to their Part 9 pages (core variables the modules merely read are not duplicated).module-loading.mdx— the Optional Modules section now cross-references Part 9.appendix-vanilla-config-map.mdx— 27 optional-module config rows now link to their Part 9 page; fixedvoicemail_ivr.conf.xml(was mis-attributed tomod_voicemail/ Chapter 19).Validation
npm run buildpasses cleanly — all 56 pages, the catalog index, and every new internal link compile with no MDX errors or broken links.🤖 Generated with Claude Code