add documentation page for api playground #3060
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
cfahlgren1
force-pushed
the
add-api-playground-to-docs
branch
from
023c8ff to
4378aa2
Compare
severo
reviewed
Sep 12, 2024
| src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/datasets-server/datasets-api-playground.png" | ||
| alt="Dataset API Playground" | ||
| /> | ||
| </a> |
There was a problem hiding this comment.
the opening tag is missing
julien-c
reviewed
Sep 12, 2024
There was a problem hiding this comment.
i'd also (and maybe more so actually) link to it from https://huggingface.co/docs/hub/datasets-viewer
WDYT?
julien-c
reviewed
Sep 12, 2024
|
|
||
| <div class="flex justify-center"> | ||
| <img | ||
| src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/datasets-server/datasets-api-playground.png" |
There was a problem hiding this comment.
potentially you can do a slightly more catchy visual like @enzostvs had done for the API playground: https://huggingface.co/docs/hub/api
(and you can embed it in other doc pages too with a more fun / simpler call to action "want to try out the API?")
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
add api playground to docs
the playground doesn't support auth yet, but plan to add soon
preview of docs page below
Dataset Viewer API Playground
The API Playground is a space that allows you to make requests to the Dataset Viewer API and visualize the results in real-time. It's a great way to explore the capabilities of the API and test different queries.