chore: Readme file uses assets that are outside of the repo

probabl-ai / skore

Skore lets you "Own Your Data Science." It provides a user-friendly interface to track and visualize your modeling results, and perform evaluation of your machine learning models with scikit-learn.

https://probabl-ai.github.io/skore/

MIT License

51 stars 1 forks source link

chore: Readme file uses assets that are outside of the repo #468

Open rouk1 opened 2 weeks ago

rouk1 commented 2 weeks ago

Which part of the documentation needs improvement?

README.md

Describe the problem found in the documentation

The README uses a static html asset and a gif.

Suggested improvement

Those assets should be hosted within the repo.

Additional context

No response

sylvaincom commented 2 weeks ago

[WIP] I will create the documentation page of the skore repo (see https://github.com/probabl-ai/skore/issues/412) in a doc folder using the PyData Sphinx 2024 theme, and will put the files for the README in that doc folder

sylvaincom commented 1 week ago

@tuscland also suggests storing as a git-LFS (https://github.com/probabl-ai/skore/pull/472#discussion_r1804401741)