[FEATURE] Generate full CLI docs from click's metadata #1084
Description
For cocoindex CLI, we're using click (cli.py), which has detailed help messages.
Currently our CLI documentation only has brief information.
We want to put these specific help messages into the CLI documentation too.
md-clickis a tool that can be potentially used to auto generate docs. There may be also more popular ones and feel free to pick.- MDX supports "import" (see this). So we can still keep existing high level information in
cli.mdx, and import the generated docs as a later section. - To keep the docs in sync down the road, consider put the script to create generated files in the
/devdirectory - (optional, can also have separate issue/PR if not easy) call the script above as a pre-commit hook in pre-commit config
❤️ Contributors, please refer to 📙Contributing Guide.
Unless the PR can be sent immediately (e.g. just a few lines of code), we recommend you to leave a comment on the issue like I'm working on it or Can I work on this issue? to avoid duplicating work. Our Discord server is always open and friendly.