Prajwal-banakar commented on PR #2474: URL: https://github.com/apache/fluss/pull/2474#issuecomment-3796642996
Hi @wuchong thank you for the insightful feedback! To address your points and clarify the integration strategy: Markdown vs. HTML Snippets: You are absolutely right. Generating HTML snippets is a much cleaner approach for embedding. I will update the generator to produce HTML tables/lists instead of pure Markdown headers. HTML is more robust for Docusaurus and prevents the "styling" of configurations from clashing with the page hierarchy. Integration Structure: My vision for incorporating this into the existing structure (like maintenance/configuration.md) is to use a marker-based injection system. I will add hidden HTML comments (e.g., and) to the existing documentation files. The fluss-docgen tool will then: Scan for these markers in the target .md files. Replace only the content between them with the latest generated HTML snippets. This ensures that manual content (introductions, custom notes) remains untouched while the configuration list stays automated. README.md: I will definitely add a README.md under the fluss-docgen module root, following the Flink example, to document how to trigger the build and how the injection logic works. Plan of Action: I will proceed with refactoring the generator to produce HTML snippets and set up the marker-based injection for the specific files you linked. I’ll also include the README in the next push. Does this refined approach align with your expectations?" -- 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]
