bluesky-social / bsky-docs Goto Github PK
View Code? Open in Web Editor NEWBluesky API documentation
Home Page: https://docs.bsky.app
License: Other
Bluesky API documentation
Home Page: https://docs.bsky.app
License: Other
(following #62)
starter templates clients explain well how to use BskyAgent agent for basis.
but (for a NooB (like me)) when we arrives on AT Protocol XRPC API (http reference introduction) : it is not easy to understand that this BskyAgent embed natively the api.
I would like to suggest adding this information plus one simple example right here
I had 4 tabs open with the same link to: https://www.docs.bsky.app/docs/api/com-atproto-server-create-account
One of the tabs showed the following error:
Explain how to generate a bearer token here: https://www.docs.bsky.app/docs/api/at-protocol-xrpc-api or update endpoints to publicly accessible ones that don't require bearer tokens
The fetch api is now included in the LTS version of NodeJS by default:
https://nodejs.org/dist/latest-v21.x/docs/api/globals.html#fetch
JS examples for using the atproto api should probably include fetch examples, and optionally make these examples the default visible example when clicking on NodeJS.
When I went to the showcase page and clicked the "Submit your project here" there were no instructions or best practices to follow. I went through previous PRs that added items to the showcase and figured it so I just submitted my first showcase project #121!
I'm not saying it needs a detailed walk through, but any mention of submissions in the Readme would be nice if that's where the submission link directs to.
Questions that would be helpful to know
This added documentation could be as simple as
src/data/users.tsx
, add your submission with {include required info}src/data/showcase/
{include image requirements/limitations}I'm also more than happy to make a PR to add this, but I don't have the answers to all of the questions right now.
I propose a little rework on the https://www.docs.bsky.app/docs/get-started page:
So by the end of the page you kind of see a minimal workable client.
The curl, python, etc code examples on the right are somehow not updated with the actual endpoint being viewed. The URL is always just a base URL (doesn't include the path), the requests are always GET (even for POST endpoints), and no body or query params are included.
I spent an hour or two poking around and can't figure out why this isn't happening. There are just a ton of layers of abstractions/plugins/packages and i'm not familiar with MDX/React to debug this myself.
We need to:
Since there is no type definition for record in the API reference, important usage of the API is unclear.
In particular, there is a concern that developers who do not use the official SDK will not be able to find a way to follow or like.
severity
is introduced as being one of "alert, inform, or none" but in the "Custom label values" table and examples I see "warning, alert, inform, or none"
Just curious if "alert" was formerly called "warning" and the docs need to be updated or if I'm misunderstanding something on how labels work.
Hi
(For starter user ) I detect the following issue
the sample provided here is really confusing
https://github.com/bluesky-social/bsky-docs/blob/main/docs/tutorials/viewing-feeds.mdx?plain=1#L39
is
const { data } = await agent.getTimeline({
cursor: "...",
limit: 30,
});
If I keep the example provided, it generates 500 error (expect 4xx)
and according to the doc, cursor default is empty.
So if I replace "..."
by ""
; then I got no issue.
Regards
When going into the API reference pages, the API playground omits the lexicon name. To be more specific, instead of seeing (for example) https://bsky.social/xrpc/app.bsky.feed.getPostThread
, you instead see https://bsky.social/xrpc
.
Below is a video showcasing this issue:
Because of this, attempting to test any APIs would lead to 404 errors.
(My apologies for the weird lines in the video: I'm not too sure why it's doing that.)
The current daily automation seems to re-generate examples using the current day as the datetime/timestamp, resulting in a lot of git history churn.
The "MDX" files frequently fail to build due to syntax errors. Would be good to have a basic CI which would try to build the existing files, if not additionally do other API auto-docs compilation.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.