docs: link from README to docs?

[jorgeorpinel]

There's a GHP docs site in https://docs.iterative.ai/dvc-task/ with an auto-generated API ref. but I don't think there's a way for users to find these docs.

Maybe add a basic index page and link from the README?

[jorgeorpinel]

BTW the API ref is empty at the moment:

https://docs.iterative.ai/dvc-task/reference/dvc_task/

[pmrowla]

The API ref isn't empty. I'm assuming it's because of the mobile stylesheet, but the API reference should be viewable if you use the nav bar

[jorgeorpinel]

I see. You need a pretty relatively wide window for the nav to display all the objects. Otherwise they're hidden in the menu (not great UX).

In any case does the site have any users? The main point of this issue is to link it from the README or from somewhere so people can find it.

[pmrowla]

In any case does the site have any users?

No. The autogenerated docs still are still experimental, questions regarding the docs UI (we are basically just using default templates afaik) should go in the template repo: iterative/py-template#19

There's still ongoing discussion as to whether or not we should be using the autogeneration tool that is currently configured (mkdocs) or something else (sphinx)