wuchong commented on PR #2474:
URL: https://github.com/apache/fluss/pull/2474#issuecomment-3831118325

   Hi @Prajwal-banakar, thanks for the update!
   
   Regarding the HTML output: my original suggestion was to generate HTML—but 
**not** as `<table>`-based markup. Instead, I meant converting the Markdown 
list structure into equivalent HTML (e.g., using `<ul>`, `<li>`) while 
preserving the list format. That said, in my follow-up comment ([#2474 
(comment)](https://github.com/apache/fluss/pull/2474#issuecomment-3796875436)), 
I clarified that **plain Markdown is actually preferable** due to better 
maintainability and native support for table-of-contents (TOC) rendering in 
Docusaurus. Sorry for the back-and-forth on this!
   
   On **file path & naming**: I still recommend placing the generated file at  
   `website/docs/_configs/_partial_config.mdx`  
   so it can be cleanly embedded via MDX imports. Could you share the exact 
error or exception you encountered? I’ve tested this locally and it works 
fine—please double-check that you’re using the correct Node.js and Docusaurus 
versions.
   
   Also, I noticed two copies of `config_reference.mdx` are being generated. We 
only need **one**, specifically at `website/docs/_configs/_partial_config.mdx`. 
Please remove the auto-generation logic that writes to 
`fluss-docgen/website/docs/maintenance/config_reference.mdx`.
   
   Finally, regarding the JaCoCo coverage failure in CI: please add a compile 
dependency on `fluss-docgen` in `fluss-test-coverage/pom.xml` so the test 
coverage tool can properly include it.
   
   Let me know if you run into any further issues!


-- 
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]

Reply via email to