fury
fury copied to clipboard
[Doc] Use a script to update documentation when code is modified
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.
- Code a script to implement the above functions.
- Add comments to all configuration fields in
FuryBuilderto provideDescriptionfor automatic generation. - Configure CI and enable
FuryBuilderconfiguration 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.