rework doc

[severo]

fixes #562

[HuggingFaceDocBuilder]

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

[severo]

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

[HuggingFaceDocBuilder]

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

[HuggingFaceDocBuilder]

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

[HuggingFaceDocBuilder]

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

[HuggingFaceDocBuilder]

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

[HuggingFaceDocBuilder]

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

[HuggingFaceDocBuilder]

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

[severo]

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

[lhoestq]

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]

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?

[stevhliu]

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