Suggestion to revampt API endpoint table (hub-docs/api.md)

[Wauplin]

Discussed multiple times. Last time in huggingface/huggingface_hub#1682 (comment). I'll first revamp the table and in a later PR add the Collection API endpoints.

Let's agree on the layout first. What I did here is to delete the table and have 1 endpoint = 1 section in the page. That should create a "nice" table of content on the right.

Any opinion or feedback? cc @julien-c @osanseviero @Pierrci

(Note: I -almost- didn't change the content but some things should be clarified. Payloads often don't include the headers so either add them everywhere or have a section dedicated to it. Also maybe at some point have different section to group APIs together (e.g. the collection API in one section). Anyway, that's off-topic for now.).

WDYT?

Current docs: https://huggingface.co/docs/hub/api
PR docs: https://moon-ci-docs.huggingface.co/docs/hub/pr_962/en/api

[HuggingFaceDocBuilderDev]

The documentation is not available anymore as the PR was closed or merged.

[julien-c]

i do think https://moon-ci-docs.huggingface.co/docs/hub/pr_962/en/api is much better already!

@gary149 WDYT?

[stevhliu]

Very nice, I think this is a lot cleaner!

[osanseviero]

Not 100% sure, but would it work to have a h2 with section titles (models, datasets, spaces, repos, user, others) and then the specific endpoints as h3?

[osanseviero]

Very nice. This is much better than current state. Thanks for tackling this!

[Wauplin]

Not 100% sure, but would it work to have a h2 with section titles (models, datasets, spaces, repos, user, others) and then the specific endpoints as h3?

Yes, I would personally be in favor of this. Haven't touched it yet as I wanted to have general feedback on the layout first before spending more time on it. I can take care of the h2/h3 section titles when adding the Collections API (#967)

[julien-c]

approving but pinging @gary149 for a super quick review!

[gary149]

Si is so much better! thank you!

[julien-c]

very cool contrib, @Wauplin <3

let's aim to grow the usage & developer experience of the Hub API in the coming months 🦾

[Pierrci]

Much clearer indeed, thanks @Wauplin!