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

rework doc #566

Merged
merged 8 commits into from
Sep 16, 2022
Merged

rework doc #566

merged 8 commits into from
Sep 16, 2022

Conversation

severo
Copy link
Collaborator

@severo severo commented Sep 15, 2022

fixes #562

@HuggingFaceDocBuilder
Copy link
Collaborator

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

@severo
Copy link
Collaborator Author

severo commented Sep 15, 2022

ping @mishig25 for the doc build error: https://github.com/huggingface/datasets-server/actions/runs/3061780931/jobs/4941975152.

@HuggingFaceDocBuilder
Copy link
Collaborator

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

@HuggingFaceDocBuilder
Copy link
Collaborator

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

@HuggingFaceDocBuilder
Copy link
Collaborator

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

@HuggingFaceDocBuilder
Copy link
Collaborator

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

@HuggingFaceDocBuilder
Copy link
Collaborator

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

@HuggingFaceDocBuilder
Copy link
Collaborator

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

@severo
Copy link
Collaborator Author

severo commented Sep 15, 2022

I'm interested in your comments @julien-c @stevhliu @lhoestq!

@lhoestq
Copy link
Member

lhoestq commented Sep 16, 2022

Cool thanks ! What about having several top-level sections e.g.

  • First "Quickstart" that shows the main usage of the API
  • Then "How to guides" to go further into details ("Check a dataset validity", "List configurations and splits" and "Preview the data")
  • Finally a "Conceptual Guide" to explain the relationship between configs and splits, the typing logic etc.

Maybe @stevhliu can help as well

@severo
Copy link
Collaborator Author

severo commented Sep 16, 2022

OK, good idea. Maybe we can do this in a new PR after merging this one? @stevhliu are you interested in working on it with me?

This was referenced Sep 16, 2022
Closed
Closed
@severo severo merged commit 25b80c6 into main Sep 16, 2022
@severo severo deleted the rework-doc branch September 16, 2022 13:02
@severo severo mentioned this pull request Sep 16, 2022
Closed
@stevhliu
Copy link
Member

Hey @severo, happy to help and work on this with you! 🙂

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

@julien-c julien-c Awaiting requested review from julien-c

@lhoestq lhoestq Awaiting requested review from lhoestq

@stevhliu stevhliu Awaiting requested review from stevhliu

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve the docs pages
4 participants
@severo @HuggingFaceDocBuilder @lhoestq @stevhliu