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.

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

docs: Modify the doc following the v0.5 release, part 1 #1007

Closed
26 tasks done
sylvaincom opened this issue Dec 23, 2024 · 0 comments · Fixed by #1004
Closed
26 tasks done

docs: Modify the doc following the v0.5 release, part 1 #1007

sylvaincom opened this issue Dec 23, 2024 · 0 comments · Fixed by #1004
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@sylvaincom
Copy link
Contributor

sylvaincom commented Dec 23, 2024

Taking into account comments from @tuscland, @MarieS-WiMLDS and @sylvaincom (see #1008 for the second iteration):

  • README
    • update the cross-validation example
  • overall
    • the logo on the top left is too big
    • change Twitter into X
    • add Bluesky
    • add LinkedIn
    • add YouTube
    • "Probabl website" -> "Probabl"
  • landing page
    • the logo is too small
    • remove the parts about starring
    • remove the badges
    • the orange color is not the correct one
    • remove the right side bar
  • install
    • change the tab appearance
    • "Skore" with uppercase if at the beginning of a sentence
    • remove the what's next
  • user guide
    • "examples" -> "user guide"
    • "Quick start": to be created
    • "Getting started with skore" -> "Skore product tour"
    • "Tracking items using their history" -> "Tracking items"
    • "Overview of the skore project" -> "Working with projects"
    • "Enhancing cross-validation" -> "Cross-validation"
    • "Enhancing train-test split" -> "Train-test split""
    • remove the "Track" section
    • in the tracking example, rename item_history into passed_item
    • rename "Diagnose" into "Model evaluation"
  • contributing
    • Change the first sentence into "Thank you for your interest in contributing to Skore! We welcome contributions from everyone and appreciate you taking the time to get involved."
@sylvaincom sylvaincom self-assigned this Dec 23, 2024
@sylvaincom sylvaincom added the documentation Improvements or additions to documentation label Dec 23, 2024
@sylvaincom sylvaincom changed the title docs: Modify the doc following the v0.5 release docs: Modify the doc following the v0.5 release, part 1 Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant