fury icon indicating copy to clipboard operation
fury copied to clipboard

[Doc] Use a script to update documentation when code is modified

Open LiangliangSui opened this issue 1 year ago • 0 comments

Is your feature request related to a problem? Please describe.

Currently, when we add or modify configuration fields in FuryBuilder, we need to manually update the table in java_serialization_guide.md#furybuilder--options

Describe the solution you'd like

Code a script to automatically update the content in java_serialization_guide.md#furybuilder--options when the content in FuryBuilder is modified.

Divide the feature into three stages for implementation.

  1. Code a script to implement the above functions.
  2. Add comments to all configuration fields in FuryBuilder to provide Description for automatic generation.
  3. Configure CI and enable FuryBuilder configuration field detection in CI. When a configuration field is added or modified, if the doc is not updated, CI fails and prompts that the doc needs to be updated.

Additional context

LiangliangSui avatar May 24 '24 14:05 LiangliangSui