xuang7 opened a new issue, #9031: URL: https://github.com/apache/texera/issues/9031
### Feature Summary We have over 150 operators. To improve their accessibility we need an organized reference for them: a page for each operator that lists its properties. Maintaining this by hand is error-prone and the pages fall out of date, so the reference should be generated from the operator source code. The current pages under docs/reference/operators/ were produced by an earlier version of this generator in April and have been maintained by hand since. This proposal lands the generator itself so the pages can be regenerated at any time. ### Proposed Solution or Design Add a generator under docs/ that maps each operator class to its reference page: it reads the annotations on the class and builds the whole docs/reference/operators/ tree from them. For each operator it reads the title, description, requirement and default of every property, the property type (enum options, accepted column types, nested config classes), which properties are shown only when a switch is on, the UDF code template, the output port modes, and the sklearn hyperparameter enums. It writes one page per operator in its group directory, an index per group, the root index, and the parameter pages. The groups come from OperatorGroupConstants, so a new operator or group shows up on the next run. Everything under the directory is regenerated except the hand-written output-modes.md, so a renamed or removed operator leaves no stale page. The generator is its own sbt module, excluded from the docs-to-website sync, with tests in CI. As a follow-up, the generator can run automatically, for example as part of each release, to keep the published reference up to date. ### Affected Area _No response_ -- 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]
