Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
rouk1 opened this issue Oct 10, 2024 · 4 comments
Closed

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

rouk1 opened this issue Oct 10, 2024 · 4 comments
Assignees
@sylvaincom
Labels
chore Internal enhancement work to be done documentation Improvements or additions to documentation

Comments

@rouk1
Copy link
Contributor

rouk1 commented Oct 10, 2024

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
@rouk1 rouk1 added documentation Improvements or additions to documentation needs-triage This has been recently submitted and needs attention labels Oct 10, 2024
@rouk1 rouk1 mentioned this issue Oct 10, 2024
Merged
@sylvaincom
Copy link
Contributor

[WIP] I will create the documentation page of the skore repo (see #412) in a doc folder using the PyData Sphinx 2024 theme, and will put the files for the README in that doc folder

@sylvaincom sylvaincom self-assigned this Oct 10, 2024
@sylvaincom sylvaincom mentioned this issue Oct 17, 2024
Merged
@sylvaincom
Copy link
Contributor

@tuscland also suggests storing as a git-LFS (#472 (comment))

@tuscland tuscland added chore Internal enhancement work to be done and removed needs-triage This has been recently submitted and needs attention labels Oct 23, 2024
@sylvaincom sylvaincom mentioned this issue Nov 5, 2024
Closed
8 tasks
@sylvaincom
Copy link
Contributor

@thomass-dev could you link the according PR and close this issue now that you set up GIT LFS? 🙏

@thomass-dev
Copy link
Collaborator

Closed by #870.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sylvaincom sylvaincom

Labels
chore Internal enhancement work to be done documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@tuscland @rouk1 @thomass-dev @sylvaincom