scikit-lego icon indicating copy to clipboard operation
scikit-lego copied to clipboard

[DOCS] Proposed addition: Adding a Quickstart or Overall User Guide Landing Page

Open iuliaferoli opened this issue 11 months ago • 0 comments

Description

I'm proposing adding one page to the User Guide as a Landing / starting point for going through the examples.

Where

This could be the page you link to from the Usage section on the Home Page:

To see more examples, please refer to the user guide section Or be part of the Home Page itself.

This Quickstart or Overview would be similar to the Getting Started Page on scikit-learn, with the purpose of providing an overview of the capabilities of scikit-lego and linking to each of the other sections in the User Guide.

Potential structure:

Datasets

Preporcessing (including feature engineering)

Pipelines

Models (including Algorithms)

What

  • This Quickstart would pick a dataset and go through an end-to-end project;
  • For each section we highlight "this is one possible element/example from that respective category" and link to the appropriate User Guide Sections to read more about it here
  • Each section can also highlight the "this is what you can do with scikit-learn" and "these are the additional benefits/shortcuts/additions that scikit-lego brings to this part of the process.

iuliaferoli avatar Mar 23 '24 13:03 iuliaferoli