Prajwal-banakar commented on PR #2474: URL: https://github.com/apache/fluss/pull/2474#issuecomment-3800524313
"Hi @wuchong I have completed the task of automating the configuration documentation. I’ve implemented a reflection-based generator in a new fluss-docgen module that ensures our docs stay perfectly in sync with the ConfigOptions source code. Note on File Path & Naming: While implementing the MDX integration, I encountered a technical limitation with Docusaurus's path resolution. When the generated file was located in a separate _configs folder and used an underscore prefix (e.g., _partial_config.mdx), the development server failed to resolve the relative import, resulting in 'Module not found' errors. To resolve this and ensure a stable build, I made two adjustments: I moved the generated config_reference.mdx into the same directory as configuration.md (website/docs/maintenance/). I removed the underscore prefix to ensure Docusaurus treats it as a standard, resolvable MDX component. This setup is currently working perfectly on the local site. Please let me know if you’d prefer a different organizational structure, and I’ll be happy to adjust! -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
