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

Remove some content from the README in favour of the documentation #958

Merged
merged 6 commits into from
Oct 9, 2023

Conversation

osanseviero
Copy link
Contributor

No description provided.

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

Copy link
Member

@OlivierDehaene OlivierDehaene left a comment

Choose a reason for hiding this comment

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

I'm all for linking to the docs but maybe this goes a bit too far? The README should still be usable IMO.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@osanseviero
Copy link
Contributor Author

Thanks for the feedback! I did a pass bringing back some of the content as suggested! Happy to go further and keep closer to the current README and just throw some links here and then

OlivierDehaene
OlivierDehaene previously approved these changes Sep 6, 2023
Copy link
Member

@OlivierDehaene OlivierDehaene left a comment

Choose a reason for hiding this comment

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

Thanks!

@OlivierDehaene
Copy link
Member

Could you resolve the conflicts and then we can merge :)

@osanseviero
Copy link
Contributor Author

This is in mergable state :) thanks @pcuenca !

Copy link
Contributor

@merveenoyan merveenoyan left a comment

Choose a reason for hiding this comment

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

LGTM

@merveenoyan merveenoyan merged commit dd304cf into main Oct 9, 2023
2 checks passed
@merveenoyan merveenoyan deleted the remove_readme branch October 9, 2023 09:59
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.

4 participants