bluesky-social/atproto-website

atproto-website's Issues

Broken Hyperlink

The application guides, specifically the signing-in section is currently referencing to a page that does not exist.

The paragraph that has the link: https://atproto.com/guides/applications#signing-in
The hyperlink: https://atproto.com/lexicons/com-atproto-session

The exact line where the 404 is

atproto-website/content/guides/applications.md

Line 18 in a3081a7

Sign-in and authentication is a simple session-oriented process. The [com.atproto.session lexicon](/lexicons/com-atproto-session) includes APIs for creating and managing these sessions.

specs/lexicon: add recordkey (`rkey`) and TID (`tid`) string format types

This is mostly just symmetry/completeness. We specify the syntax of these in the specs, but don't have Lexicon-specific formats for them. rkey is pretty flexible, but has a restricted character set and doesn't allow whitespace.

tid isn't used in any current Lexicons, but has a more restricted syntax, and may pop up in more sync Lexicons if we use it for repo rev/clock field.

I can both draft a spec PR and add syntax check tests to atproto (typescript) if that is helpful.

cc: @devinivy @dholms

https://atproto.com/faq should not 404

what would be good for it to point to?

Enable GitHub Discussion.

My rationale is available at 8go/matrix-commander#68 (comment).

Update GitHub repo link to https://atproto.com

Please update this to link to the website this repo is for

Node IPLD specification is incorrect and incomplete

https://atproto.com/specs/repository#mst-structure

atproto-website/content/specs/repository.md

Lines 85 to 92 in 4744a24

	The node IPLD schema fields are:
	- `l` ("left", CID link, optional): link to sub-tree Node on a lower level and with all keys sorting before keys at this node
	- `e` ("entries", array of objects, required): ordered list of TreeEntry objects
	- `p` ("prefixlen", integer, required): count of bytes shared with previous TreeEntry in this Node (if any)
	- `k` ("keysuffix", byte array, required): remainder of key for this TreeEntry, after "prefixlen" have been removed
	- `v` ("value", CID Link, required): link to a sub-tree Node at a lower level which has keys sorting after this TreeEntry's key (to the "right"), but before the next TreeEntry's key in this Node (if any)

The v field is documented as:

• ✅ A CID link.
• ✅ Required.
• ⚠️ A link to a sub-tree Node.

After experimenting with my own repository's CAR, I've concluded that this is most likely an accidental merge of two separate fields:

• v:
  • A CID link.
  • Required.
  • A link to the Lexicon value corresponding to this TreeEntry's key.
• t:
  • A CID link.
  • Optional (CID link || null).
  • A link to a sub-tree Node.

specs: auth "entryway" mechanism (detect actual PDS instance)

Update the Readme

The readme has default Next.js content. Some example sections for this:

• What, or How
• Features
• Screenshots
• How it works, Getting Started, or Deploy
• Support
• Troubleshooting & FAQ
• Team, or Contributors
• References
• License

Website loses Accessibility setting (same as in App)

Describe the bug
To ensure the accessibility of my skeets I set the requirement for alt texts for all images. I did so on the website and I did so in the app. I cannot remember which setting was first. I would expect that this requirement is synchronized for the user. Last week I stumbled upon my settings on the website, and I found this requirement not set. I set it again. Today I found it unset again. In my app it is still set.

I have already sent this issue regarding the App in Issue 1357 over there, so this could be merged if feasible.

To Reproduce

Steps to reproduce the behavior:

I seem to find the Accessibility setting reset on the website every other day.

Expected behavior

The accessibility setting should a) be an accountwide setting and not limited to the way of connecting to Bluesky
The website must not forget the accessibility setting.

Screenshots

Details

Platform: Google Chrome on various Windows desktops, App on Android
Platform version: Windows 10 Pro 22H2 and Windows Server 2019 (Version 1809) via remote server and Android 13
App version:

Additional context

I have set the accessibility setting at least 5 times since I have signed up. If one time setting was not enough, at least the setting in one browser should be enough to remember this. As the function is used to remind ME to use alt texts, I should not have to remind setting the requirement first, when I use Bluesky via browser.

Broken Lexicon links on documentation overview pgae

On https://atproto.com/guides/overview#interoperation there are two links, "ATP Lexicon" and "Bsky Lexicon" which are returning 404. They appear to have led to /lexicons/atproto-com and /lexicons/bsky-app at some point but both of those links are now missing.

Looking at the sidebar it looks like there aren't overview pages for the atproto and bsky lexicons, so I'm not sure where these are intended to link.

service proxying details needed

will eventually want to address:

• possible /.well-known/ pre-flight check
• ability to not forward on service token (or reduce it's scope)
• details about what other headers should be passed along (or not), including content negotiation
• whether to do a "forwarded for" header or not (probably not, for privacy reasons?)
• caching
• websockets
• server-side retries, timeouts, circuit-breaking
• status codes

show scrollbar on the blog site

Hey, I'm not sure where to report this, because I think the blog is in a different repo (private one probably), but could you please change the style on the blog so that the scrollbar shows up? I don't know which stylesheet line it is specifically, but something must be explicitly hiding the scrollbar because otherwise it would be displayed normally by default. I don't know what the intention was, but this makes it confusing because you don't know at what position you are in relation to the whole document and how much more you have to read when scrolling through a blog post.

bug: the email input on the subscription form in the footer is cutoff on mobile

Describe the bug
On my iPhone the email input in the footer is almost too small to see.

To Reproduce

Steps to reproduce the behavior:

1. Visit the Bluesky homepage at https://blueskyweb.xyz/
2. Scroll down to the footer
3. Observe the email input is only covering a fraction of the width of the screen.

Expected behavior

The email input should span the width of the screen and the subscribe button should be on the line below.

Screenshots

Issue and Bug report Template Creation

Hello, I would like to work on two templates for issue and bug report creation for this repo. It will make the process easier for contributors.

Please let me know If I can work on this.

Thank you.

add rdmurphy/atproto-openapi-types to projects list

specs: document XRPC proxying / pass-through

How PDS implementations should handle proxying application endpoints through to an appview:

• how route such requests (which endpoints to which AppView instance)
• HTTP headers to include in upstream request
• how to handle errors, retries, backoff, timeouts, rate-limits

The documentation for many API endpoints that returns lists of objects does not specify the sorting order

The documentation for many API endpoints that returns lists of objects does not specify the sorting order

To Reproduce

Steps to reproduce the behavior:

1. Go to https://atproto.com/lexicons/app-bsky-feed#appbskyfeedgetauthorfeed

Expected behavior

Sorting order is documented. It can be useful for apps that can paginate Authors Feed up to the first message they have previously seen and stop there. Some other APIs can benefit from having the order of returned objects to be documented so it can be relied on.

Details

• Operating system: N/A
• Node version: N/A

Additional context

N/A

additional spec docs (Spring 2024)

Things that are maturing and need formal write-ups in the specs:

• Blobs: media files referenced by records, but stored and transmitted separately (short spec)
  • getBlob, uploadBlob
  • document behavior of re-uploading a blob in the same repo (HTTP status code, etc)
  • document sort-order of list blobs (?)
• Repository Sync: how content flows though the system
  • repo event stream ("firehose"): event schemas and details
  • getRepo endpoint
  • requestCrawl / notifyOfUpdate
• Accounts
  • account migration
  • lifecycle states
  • private settings
• Auth
  • service auth (JWTs)
  • OAuth
• Labels
  • schema/fields
  • negation
  • signature lifecycle (with key rotation)
  • stream format
  • HTTP header

Additions to existing specs:

• HTTP: generic proxying to remote services, based on HTTP headers
• Data Model: recommended limits

Lexicon specs are missing, links 404

Steps to reproduce

1. Navigate to the documentation for a specific lexicon (e.g. https://atproto.com/guides/applications#appbskyfeedpost)
2. Click on its name (which in the above case navigates to https://atproto.com/lexicons/app-bsky)

Expected

I should see the app.bsky lexicon specification (ideally for app.bsky.feed.post in the above example).

Actual

A very pretty 404 error page.

Modified import statement to module path aliases

Overview

Modified import statement of JSX files to module path aliases.

Why

This was addressed because each time the directory gets deeper, the import minute gets longer.

Docs

https://nextjs.org/docs/advanced-features/module-path-aliases

Implement waitlist signup

Lexicon links 404

Might not be the right place to inform, but https://atproto.com/lexicons/app-bsky-feed#post and other links on the ATProto docs site seem to be 404-ing currently.

Translations?

I'm not sure if that's the right place to suggest ideas, but I was wondering how can I help with the translation of the website to Brazilian Portuguese, since I'm a native on the language. Do you, developers, ever considered placing that option? That'd make users from other countries to understand better all the documentation written and help clarify things up more easily. Let me know if I can do so, and how! It'd be a pleasure.

Broken /lexicons/com-atproto-handle hyperlink

This is similar (but different than issue #44). It's a different hyperlink.

Page: https://atproto.com/guides/identity

Paragraph:

Handles are DNS names. They are resolved using the com.atproto.identity.resolveHandle() XRPC method and should be confirmed by a matching entry in the DID document.

Broken Link: https://atproto.com/lexicons/com-atproto-handle

specs: clarify non-removal of off-spec fields from data records

Eg, by all services, including PDS.

See also: bluesky-social/atproto#2126

pds build instructions

could provide build instructions on how to make a pds in the docs somewhere, I had to manually figure out how the repo is set up to set up my own pds

[Feature request] Add a search

Hello!

Having a search the a documentation website would be so helpful! I went ahead and did my own version of your doc with a docsearch on it. https://atproto-search.vercel.app/docs

If you'd like to have it up and running on atproto it'll be a pleasure to help!

Also having a docsearch is free! :)

Fix styling on `/lexicons/*`

Issue

Some of the headings in the lexicons extend beyond the viewport and cause an overflow. This can easily be fixed by wrapping the text, breaking it, or reducing font size(not optimal)

Pruning third-party clients that are no longer being maintained

With the app.bsky.unspecced.getPopular endpoint being deprecated and soon to be removed, it might be worthwhile checking up on the current list of third-party clients and see if they're still being maintained.

Some of them are actually dead, some of them just has been inactive, I haven't checked if any of these uses the deprecated endpoint, for the inactive ones it might be worthwhile to reach out to see if they're still maintaining it, or perhaps move them to a dedicated "inactive" section

Rate Limit Exceeded on the site. Nothing works really.

It acts like I am a new account, no profile pic, following no one.

specs: consider limiting record-key length to 64 (not 512)

Raised by @dholms in bluesky-social/atproto#1738 (comment)

I'm generally open to this. The main consideration to me is what tricks we might want to use to stuff other identifiers in to record keys to make lookups easier. Eg, CIDs if the record is metadata about a blob, DID if metadata about accounts (maybe we should have done that for follows!), etc.

Fix the social media card images

outdated info in readme: /api/hello endpoint not present

Specify license for documentation

There is currently no LICENSE file in this repository. Is the intention for the docs to be MIT-licensed or under a similarly open license? If so, it would be good to state that clearly.

specs: note in auth/JWT/crypto specs that we don't enforce low-S for JWT service auth

See also: bluesky-social/atproto#2256

disallow special `.alt` domain (for now) in handles

specify expectations for "service DIDs" like feed generators

Eg, as documented at https://github.com/bluesky-social/feed-generator/tree/main

We haven't really done enough of these to spec these out. Not sure if we'll do a registry, or should try to encode these in Lexicons, or what. The current DID spec mentions that atproto_pds is required, but that isn't true for this; but on the other hand these aren't regular atproto accounts (they don't have a repo).

Add the lexicons

Footer year should not be static

The footer's copyright year should not be static, we can render this using a date function.

HTTP Basic authentication header example seems wrong.

https://github.com/bluesky-social/atproto-website/blob/main/content/specs/xrpc.md#admin-token-temporary-specification says Authorization header would be Basic admin:c2VjcmV0LXRva2Vu where the username is "admin" and the password is "secret-token".

On the other hand, RFC 7617 Section 2 says Base64-encoding must be done after concatenating the user-id, a single colon (":") character, and the password.
That means Authorization header would be Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== where the username is "Aladdin" and password "open sesame".

For example, cURL adopts the latter.
Is the description in 'content/specs/xrpc.md' a documentation error?

RSS for /blog

Please add RSS to https://atproto.com/blog so we can follow...

specs: allow digits in DID method

Allowing digits does seem to be correct upstream:
https://www.w3.org/TR/did-core/#did-syntax

and there are methods like did:3 and did:web7 which use them:
https://w3c.github.io/did-spec-registries/#did-methods

As part of this change we should:

• update the specs and examples
• update the shared interop test vectors
• update golang SDK (indigo)
• update typescript SDK (atproto)
• dev comms to other promoted SDK maintainers

Feels like a bit of a bummer that they allow this as it visually blurs with host:port style syntax, but I guess the required second colon disambiguates.

cc: @matthieusieben

specs/lexicon: document new 'language' string format

As added in bluesky-social/atproto#1219

Guide and spec are inconsistent in defining `LexiconDoc`

For fun I'm writing a parser for lexicons while following the guide at https://atproto.com/guides/lexicon which I believe is rendered from this repository.

I paused to write this ticket to glance at PR and found #29 which updates the lexicon spec (in contrast to the guide).

So them I went back to compare the spec to the guide in the main branch and it appears they're inconsistent.

From the guide it introduces LexiconDoc as:

interface LexiconDoc {
  lexicon: 1
  id: string // an NSID
  type: 'query' | 'procedure' | 'record' | 'token'
  revision?: number
  description?: string
  defs?: JSONSchema
  // if type == record
  key?: string
  record?: JSONSchema
  // if type == query or procedure
  parameters?: Record<string, XrpcParameter>
  input?: XrpcBody
  output?: XrpcBody
  errors?: XrpcError[]
}

-while the spec defines LexiconDoc as:

interface LexiconDoc {
  lexicon: 1
  id: string // an NSID
  revision?: number
  description?: string
  defs: Record<string, LexUserType|LexArray|LexPrimitive|LexRef[]>
}

The JSON files I see in https://github.com/bluesky-social/atproto/tree/main/lexicons seem to follow the spec version.

Bug : Twitter Logo Not Updated on Bluesky Homepage

Describe the bug
Twitter Logo Not Updated on Bluesky Homepage

To Reproduce

Steps to reproduce the behavior:

1. Visit the Bluesky homepage at https://blueskyweb.xyz/
2. Observe the Twitter logo displayed on the page.

Expected behavior

The Twitter logo should reflect the latest design and branding, ensuring visual consistency with the official Twitter logo.

Screenshots

specs/data: reserve all fields starting with `$` for Lexicon usage

specs/handle: document special `handle.invalid` value

Clarify "72 hour window"

https://atproto.com/guides/overview

Signing key: Asserts changes to the DID Document and to the user's data repository.
Recovery key: Asserts changes to the DID Document; may override the signing key within a 72-hour window.

This description of what the recovery key does is completely unclear. What acts can it override? What happens at the end of the time window? As a reader, as far as I'm aware at this stage in the document, everything we'd do with the signing key happens instantly, and doesn't have a time window. I think it has to be explained what operations this window applies to.

Typo on lexicon guide

On Lexicon page I think this

app.bsky.fed.post

is supposed to be

app.bsky.feed.post

Also this

at://bob.com/com.example.follow/1234

Based on the example in the lines listed

{
  "$type": "com.example.follow",
  "subject": "at://did:plc:12345",
  "createdAt": "2022-10-09T17:51:55.043Z"
}

would be

at://bob.com/com.example.follow/12345

possibly link to interop test vectors (in atproto repo) from syntax definitions