System information

The latest main branch

What is the problem that this feature solves?

• To prevent confusion and save maintenance effort, keep single place for ONNX operators
• Reduce engineering effort for frequently updating Operators.md; Web content is automatically generated

Alternatives considered

Still keep docs/Operators.md and docs/Operators-ml.md.

Describe the feature

ONNX now has a better web version for operators documentation: https://onnx.ai/onnx/operators/. To keep single place for Operators documentation, retire docs/Operators.md and docs/Operators-ml.md.

However, the drawback is without docs/Operators.md it's hard for the reviewers to preview documentation changes in ONNX PR. Ideally we should make web content for operators documentation also previewable.

Thus, two action items:

• Make web content for operators documentation previewable (shown in PR) when there is a doc change in C++ files
• Announce the retirement of docs/Operators.md and docs/Operators-ml.md. Provide the URL (https://onnx.ai/onnx/operators/) in Operators.md instead to let users visit onnx.ai instead

Currently there are also other documentations like TestCoverage.md and TestCoverage-ml.md which need to be updated by gen_doc.py. We can decide whether retire them as well after there is also web version of them on onnx.ai.

Will this influence the current api (Y/N)?

N

Feature Area

documentation

Are you willing to contribute it (Y/N)

Yes

Notes

Anyone has any concern feel free to chime in. Thanks!