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
662 stars 58 forks source link

[Hotfix] Cleanup README (+ RTD sync) #833

Closed yoonspark closed 1 year ago

yoonspark commented 1 year ago

Summary

As per recent feedback from an external reviewer, we want to improve README so that a new user can onboard more quickly/effectively.

Changes

PR also includes changes to sync RTD pages with the above README updates.

Testing

This PR does a pure docs update, so no need for automated testing. Examples used in docs have been validated locally.

Ticket(s)

This PR resolves https://linea.atlassian.net/browse/LIN-700.

becca-miller commented 1 year ago

I've made some minor edits to the README based on our call earlier today!

yoonspark commented 1 year ago

@dorx I am merging this PR for ODSC which is happening today.