Closed yoonspark closed 1 year ago
As per recent feedback from an external reviewer, we want to improve README so that a new user can onboard more quickly/effectively.
Quick Start
Python 3 (ipykernel)
Interfaces
PR also includes changes to sync RTD pages with the above README updates.
This PR does a pure docs update, so no need for automated testing. Examples used in docs have been validated locally.
This PR resolves https://linea.atlassian.net/browse/LIN-700.
I've made some minor edits to the README based on our call earlier today!
@dorx I am merging this PR for ODSC which is happening today.
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
Quick Start
sectionPython 3 (ipykernel)
)Interfaces
section beforeQuick Start
so the user knows how to load LineaPy extension before hands-on practicePR 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.