LineaLabs / lineapy

Move fast from data science prototype to pipeline. Capture, analyze, and transform messy notebooks into data pipelines with just two lines of code.
https://lineapy.org
Apache License 2.0
664 stars 58 forks source link

LIN-716 Reorganize RTD contents #856

Closed yoonspark closed 1 year ago

yoonspark commented 1 year ago

Summary

Based on feedback from external reviewers (primarily Alejandra’s), we want to reorganize our RTD contents such that they provide a smoother onboarding experience for new users. Concretely, we want to reorganize RTD contents into the following sections:

The objective of this story is NOT to add new contents but rather to reorganize existing ones. New contents shall be added through different stories.

The updated RTD can be previewed at: https://docs.lineapy.org/en/lin-716-reorg-rtd-contents/

Changes

Testing

CI will kick in to evaluate tutorial notebooks.

Ticket(s)

yoonspark commented 1 year ago

@lionsardesai Could you review this PR? Most changes (i.e., changes in docs/, examples/, and .colab/) are documentation changes, which you can better review in RTD: https://docs.lineapy.org/en/lin-716-reorg-rtd-contents/.

Code changes happened at:

yoonspark commented 1 year ago

Things to be done after this PR is merged to main:

  1. Merge main into v0.2.x so that Colab links get updated (Colab is currently pointing to v0.2.x)
  2. Update Colab links in each tutorial notebooks (use explicit links, instead of abbreviated ones)