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(readme): Update README.md #413

Merged
merged 24 commits into from
Oct 10, 2024
Merged

docs(readme): Update README.md #413

merged 24 commits into from
Oct 10, 2024

Conversation

sylvaincom
Copy link
Contributor

@sylvaincom sylvaincom commented Sep 30, 2024

WIP, according to #411

@sylvaincom sylvaincom mentioned this pull request Sep 30, 2024
7 tasks
@augustebaum augustebaum marked this pull request as draft September 30, 2024 15:04
@rouk1
Copy link
Contributor

rouk1 commented Oct 3, 2024

IMHO we miss the pip install line in the quickstart section.

@sylvaincom sylvaincom marked this pull request as ready for review October 7, 2024 16:08
Copy link
Contributor

@rouk1 rouk1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about adding gif to the README ?
This gif could be a notebook side by side with a skore ui demonstarting the UI.
I personally tend to read longer if I see images.

For inspiration see zoxide's readme which demonstartes the tool in a few seconds using a gif.
More inspiration in the awesome readme repo.

@augustebaum augustebaum changed the title Update README.md docs(readme): Update README.md Oct 8, 2024
@sylvaincom
Copy link
Contributor Author

For a first iteration, it looks good to me, what do you think?

tuscland
tuscland previously approved these changes Oct 9, 2024
Copy link
Member

@tuscland tuscland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice improvement

- clearing outputs of the notebook
- generating py (jupytext)
- project.list_item_keys()
augustebaum
augustebaum previously approved these changes Oct 9, 2024
thomass-dev
thomass-dev previously approved these changes Oct 9, 2024
@thomass-dev
Copy link
Collaborator

thomass-dev commented Oct 9, 2024

@sylvaincom this snippet will fix the README.md for you (there is something wrong).

python -m pip install --upgrade pip               
python -m pip install --upgrade pre-commit        
                                                  
pre-commit run --all-files check-yaml             
pre-commit run --all-files check-toml             
pre-commit run --all-files check-added-large-files
pre-commit run --all-files check-merge-conflict   
pre-commit run --all-files detect-private-key     
pre-commit run --all-files end-of-file-fixer      
pre-commit run --all-files trailing-whitespace    
pre-commit run --all-files typos                  

@sylvaincom sylvaincom dismissed stale reviews from thomass-dev and augustebaum via ba936bd October 9, 2024 14:02
Copy link
Contributor

@rouk1 rouk1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To go forward I'll approve this and create an dedicated issue for the notebook pre commit hook.

@rouk1
Copy link
Contributor

rouk1 commented Oct 10, 2024

IMHO readme assets should not be hosted outside of the repo.

@thomass-dev thomass-dev merged commit 1715bd3 into main Oct 10, 2024
5 checks passed
@thomass-dev thomass-dev deleted the 411-improve-readme branch October 10, 2024 08:15
@rouk1
Copy link
Contributor

rouk1 commented Oct 10, 2024

See new issues #468 & #467

thomass-dev pushed a commit that referenced this pull request Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants