clink icon indicating copy to clipboard operation
clink copied to clipboard

Add document for API usage and examples

Open yunfengzhou-hub opened this issue 3 years ago • 0 comments

Clink needs more documentation and examples about the usage of Clink APIs so as to improve Clink's readability and usability. It is equally important to setup conventions for the whole documentation system for Clink's infrastructure and operators.

Possible implementation details of this issue could be to

  • Add a docs/ folder containing markdown files of user guides
  • Add various Clink programs as examples
  • Add more detailed description directly to APIs, like Flink has done to org.apache.flink.table.api.Table.

yunfengzhou-hub avatar Jan 21 '22 03:01 yunfengzhou-hub