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

Add sandboxes to Get Started #61

Open
gaearon opened this issue Feb 6, 2024 · 2 comments
Open

Add sandboxes to Get Started #61

gaearon opened this issue Feb 6, 2024 · 2 comments

Comments

@gaearon
Copy link
Contributor

gaearon commented Feb 6, 2024

I propose a little rework on the https://www.docs.bsky.app/docs/get-started page:

  • Let's show a read-only example first. E.g. showing a list of someone's posts. This is to demonstrate how easy it is to get started, and that you don't need a "developer account" or an "API key" or all the stuff that's usually necessary to hit an API.
  • Let's make this example runnable directly on the page. E.g. via StackBlitz. I'm obviously biased but I think a React example like https://www.docs.bsky.app/docs/starter-templates/clients would be nice (except runnable and showing a list of posts rather than a list of feeds).
  • Then let's move the part that requires authentication (posting) down the page a bit. So that it comes after the read-only example. Could be an extension to the first example. (E.g. the example switches to showing own posts -> and then shows how you can add a new one.)

So by the end of the page you kind of see a minimal workable client.

@bnewbold
Copy link
Contributor

bnewbold commented Feb 7, 2024

Stripe API docs let you put in an account identifier and all the examples get filled out. IIRC they also have a clear staging/test mode for everything, so you can experiment with real accounts and try things like credit card transactions and not have it actually bill to a bank, which is very helpful.

I've had https://codapi.org/ (intro: https://antonz.org/interactive-api-tutorials/) open in a tab forever as something to try with atproto docs and examples. It might be a bit dry or technical out of the box for Bluesky docs? Though works with Javascript (and other languages) pretty well.

Also as a note I registered atbin.dev a while back, to be an equivalent of httpbin.dev for atproto+bsky.

@gaearon
Copy link
Contributor Author

gaearon commented Feb 7, 2024

I think there's probably two complementary things here:

  • For demoing particular endpoints and code walkthroughs, something like codapi looks good
  • To reach web developers, I'd strongly recommend runnable and editable JS-only sandboxes (which lets us also make a real UI — like these)

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

No branches or pull requests

2 participants