Update docs

[daavoo]

Related with iterative/dvc.org#2443 and #45 (comment)

The existing "front page" of dvclive seems to be missing some important points that are mentioned in the README of the repository . At the very least, we could opt for syncing both sources of information by updating the existing dvc.org introduction with the information present in the README.

---

UPDATE: Jump to #86 (comment)

• Update docs index #116

• Add Command/API Reference #108

• API Reference enhancements #117

• Simplify Usage Guide #119

• Add docs for Integrations #123

[jorgeorpinel]

missing some important points that are mentioned in the README

That is definitely related with iterative/dvc.org#2443, in the sense that we need to figure out how much overlap we want between the README here and the docs in https://dvc.org/doc/dvclive

opt for syncing both sources of information

This we don't want to do. @daavoo based on that other issue, would it be possible to get a summary of the changes you think would be needed on each side? We'll figure it out later if not cc @pared 🙂

[daavoo]

@daavoo based on that other issue, would it be possible to get a summary of the changes you think would be needed on each side?

I see, I would need to review iterative/dvc.org#2443 in order to propose that summary of changes.

---

TBH this looks like a duplicate of #45 (comment).

That issue seems to be focused on the changes needed in the "README" but not the ones needed in the "docs". Not sure if we should keep a separate issue for each "target" or not

[jorgeorpinel]

Yup, now that https://github.com/iterative/dvclive/pull/99is done (thanks @daavoo) I guess we can keep this one to update the DVCLive docs index (currently in https://dvc.org/doc/dvclive). We'll need to come up with the plan first (based on iterative/dvc.org#2443) 🙂

[daavoo]

We'll need to come up with the plan first (based on iterative/dvc.org#2443) slightly_smiling_face

So here is a granular proposal of changes for dvc.org, based on the guidelines you linked:

---

• Link docs index to this repository.

Users can't reach this repository from the docs.

• Add info about summary files.

The docs index only mention the log files in .tsv format and it's integration with dvc plots. Include information about summary files in .json format and it's integration with dvc metrics.

• Extend "principles" to include the ones mentioned in the README.

I think the ones added in #71 better reflect the library comparing to those currently present in the docs index

• Add Command/API Reference

Establish a single point for reference as this is currently duplicated in several places (some of those with outdated info iterative/dvc.org#2498):

https://github.com/iterative/dvclive#quick-start
https://dvc.org/doc/dvclive/usage#initial-configuration
https://dvc.org/doc/user-guide/experiment-management/checkpoints#registering-checkpoints-in-your-code

• Simplify Usage Guide

Ref: #87 .

• Add Integrations

Document usage of existing "self-hosted" (keras, xgboost) and external (mmcv) integrations.

iterative/dvc.org#2509 (comment)

---

What do you think @jorgeorpinel ¿?

cc @pared @dberenbaum

[pared]

LGTM! Do we want to keep all of that in one place (this issue?) I think Add command/API reference might a bigger issue than other ones. Also, in this point, do you think about removing other references once this single point is established? I am asking because those three seem to have a little bit different puprose.

[dberenbaum]

Do we want to keep all of that in one place (this issue?)

I think having this issue is helpful, but also having separate issues and PRs for the individual checkboxes linking back to here would be great.

[daavoo]

Should we create those issues in dvc.org or here?

[daavoo]

Also, in this point, do you think about removing other references once this single point is established? I am asking because those three seem to have a little bit different puprose.

I wouldn't remove the other references but rather update tthe content with a link to the docs API Reference. Probably, for each of those other references, some of the parts overlapping with the docs API reference could be removed and update the remaining parts focusing on the specific purpose

[dberenbaum]

Should we create those issues in dvc.org or here?

I think we decided recently to keep that here especially if you will be the main contributor (cc @jorgeorpinel in case I'm remembering incorrectly).

[jorgeorpinel]

Yep! Better to track in the corresponding product repo even if it's currently documented in dvc.org/doc.