From 81cfd19c5c989015a9cd7c39b020719a6f2f99e9 Mon Sep 17 00:00:00 2001 From: bryan newbold Date: Tue, 26 Mar 2024 16:50:50 -0700 Subject: [PATCH] guides: remove all lexicon links --- content/guides/applications.md | 14 +++++++------- content/guides/identity.md | 4 ++-- content/guides/overview.md | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/content/guides/applications.md b/content/guides/applications.md index 2e0f6572..5721b648 100644 --- a/content/guides/applications.md +++ b/content/guides/applications.md @@ -9,13 +9,13 @@ tldr: # Applications model -Applications on the AT Protocol connect to the user's Personal Data Server (PDS) to access their account. Once a session is established, the app can use the [lexicons](./lexicon) implemented by the PDS to drive behaviors. +Applications on the AT Protocol connect to the user's Personal Data Server (PDS) to access their account. Once a session is established, the app can use the lexicons implemented by the PDS to drive behaviors. In this guide, we'll step through a couple of common patterns (with simple code examples) to help you develop an intuition about this. All APIs shown below are generated using Lexicon's code-generator CLI. ## Signing in -Sign-in and authentication is a simple session-oriented process. The [com.atproto.server lexicon](/lexicons/com-atproto) includes APIs for creating and managing these sessions. +Sign-in and authentication is a simple session-oriented process. The `com.atproto.server.*` lexicons include APIs for creating and managing these sessions. ```typescript // create an API instance with my PDS @@ -75,7 +75,7 @@ If you're noticing the "type" field and wondering how that works, see the [Intro You'll notice "cids" in some of the schemas. A "cid" is a "Content ID," a sha256 hash of some referenced content. These are used to ensure integrity; for instance, a like includes the cid of the post being liked so that a future edit can be detected and noted in the UI. -### app.bsky.graph.follow +### `app.bsky.graph.follow` A social follow. Example: @@ -87,7 +87,7 @@ A social follow. Example: } ``` -### app.bsky.feed.like +### `app.bsky.feed.like` A like on a piece of content. Example: @@ -102,7 +102,7 @@ A like on a piece of content. Example: } ``` -### app.bsky.feed.post +### `app.bsky.feed.post` A microblog post. Example: @@ -114,7 +114,7 @@ A microblog post. Example: } ``` -### app.bsky.actor.profile +### `app.bsky.actor.profile` A user profile. Example: @@ -126,7 +126,7 @@ A user profile. Example: } ``` -### app.bsky.feed.repost +### `app.bsky.feed.repost` A repost of an existing microblog post (similar to retweets). Example: diff --git a/content/guides/identity.md b/content/guides/identity.md index ac03909c..25680738 100644 --- a/content/guides/identity.md +++ b/content/guides/identity.md @@ -53,7 +53,7 @@ The DNS handle is a user-facing identifier — it should be shown in UIs and pro Handles - 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. Details in the Handle specification. + 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. Details in the Handle specification. @@ -94,7 +94,7 @@ At present, none of the DID methods meet our standards fully. **Therefore, we ha Handles in atproto are domain names which resolve to a DID, which in turn resolves to a DID Document containing the user's signing pubkey and hosting service. -Handle resolution uses the [`com.atproto.identity.resolveHandle`](/lexicons/com-atproto) XRPC method. The method call should be sent to the server identified by the handle, and the handle should be passed as a parameter. +Handle resolution uses the `com.atproto.identity.resolveHandle` XRPC method. The method call should be sent to the server identified by the handle, and the handle should be passed as a parameter. Here is the algorithm in pseudo-TypeScript: diff --git a/content/guides/overview.md b/content/guides/overview.md index f2bea320..d36e7ecd 100644 --- a/content/guides/overview.md +++ b/content/guides/overview.md @@ -29,7 +29,7 @@ The lower-level primitives that can get stacked together differently are the rep ## Interoperation -A global schemas network called [Lexicon](/specs/lexicon) is used to unify the names and behaviors of the calls across the servers. Servers implement "lexicons" to support featuresets, including the core [ATP Lexicon](/lexicons/com-atproto) for syncing user repositories and the [Bsky Lexicon](/lexicons/app-bsky) to provide basic social behaviors. +A global schemas network called [Lexicon](/specs/lexicon) is used to unify the names and behaviors of the calls across the servers. Servers implement "lexicons" to support featuresets, including the core `com.atproto.*` lexicons for syncing user repositories and the `app.bsky.*` lexicons to provide basic social behaviors. ![Interop](/img/interop.jpg)