Skip to content

Commit f4c4b09

Browse files
committed
feat: add more details to placeholder sections
1 parent 28b193c commit f4c4b09

File tree

1 file changed

+27
-24
lines changed

1 file changed

+27
-24
lines changed
Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,82 @@
11
---
22
title: Atmosphere
33
description: npmx.dev's role in the Atmosphere
4+
bailey: ''
45
navigation:
56
icon: i-lucide-cloudy
67
---
78

8-
<!-- INFO: Run locally with `pnpm dev:docs` -->
9-
<!-- TODO: Preliminary work to record all of the steps involved with the initial ATProto work. Please feel free to update and revise as you see fit. -->
10-
119
## Overview
1210

13-
_npmx.dev_ site architecture as it pertains to the ATProtocol ecosystem, the [Atmosphere](https://atproto.com/).
11+
_npmx.dev_ site architecture as it pertains to the ATProtocol (ATProto) ecosystem, the [Atmosphere](https://atproto.com/).
1412

1513
---
1614

1715
## Atmosphere
1816

19-
The Atmosphere is the interconnected web of applications that all run on the ATProtocol. The primary benefit of this integration for nomx.dev are social features and connecting to the tens of millions of users ATProtocol on the social graph. Per the docs site:
17+
The Atmosphere is the interconnected web of applications that all run on the ATProto. The primary benefits of this integration for _npmx.dev_ are the social features that connect us to the tens of millions of users on the ATProto social graph. Per the docs site:
2018

2119
> The AT Protocol is an open, decentralized network for building social applications.
2220
2321
---
2422

2523
## Architecture
2624

27-
These are the components that allow for _npmx.dev_ to exist as an app on the Atmosphere:
25+
These are the essential components that allow for _npmx.dev_ to exist as an app on the Atmosphere:
2826

29-
1. **Domain** - _npmx.dev_ site
27+
1. **App View** - _npmx.dev_ site
3028
2. **OAuth** - Required for interacting with the Atmosphere
3129
3. **Constellation** - A global atproto backlink index
3230
4. **Lexicons** - Schema definition language
33-
5. **Standard Site Sync** - Synchronizes app data with PDS
34-
6. **Bluesky Social Graph** - Consume Bluesky posts/comments/threads
31+
5. **PDS** - Personal Data Server for account hosting
32+
6. **Standard Site Sync** - Synchronizes app data with PDS
33+
7. **Bluesky Social Graph** - Consume Bluesky posts/comments/threads
34+
35+
For more details refer to the official ATProto docs [here](https://atproto.com/guides/the-at-stack).
3536

36-
### Domain
37+
### App View
3738

38-
_npmx.dev_ site which serves as a third-party browser prioritized around high DX and native-like performance...
39+
The _npmx.dev_ app is the frontend domain for the site which acts as a third-party browser for the extant [npmjs site](https://www.npmjs.com) but prioritized around high developer experience (DX) and native-like performance. As it concerns the idiomatic Atmosphere stack, it serves as the client entry point and enables user controls for `@npmx.social` profiles.
40+
41+
For more details refer to the official ATProto docs [here](https://atproto.com/guides/the-at-stack#app-views).
3942

4043
### OAuth
4144

42-
Necessary to ensure identities are observed...
45+
Access to any ATProto affiliated entity requires an authneticated web presence, this is achieved via OAuth verification. OAuth is strictly necessary to ensure user identities are securely authenticated against their respective PDS without exposing credentials to _npmx.dev_ directly.
4346

4447
> OAuth is the primary mechanism in atproto for clients to make authorized requests to PDS instances.
4548
46-
https://atproto.com/specs/oauth
49+
For more details refer to the official ATProto docs [here](https://atproto.com/specs/oauth).
4750

4851
### Constellation
4952

50-
Orchestration API layer that collects...stuff...
53+
Constellation serves as the API orchestration layer and backend indexer. It acts as a bridge between _npmx.dev_ specific data structures and the wider ATProto network. Specifically, it indexes backlinks, aggregates app-view data, and manages the caching layer to reduce load on individual PDS instances during high-traffic events.
5154

5255
### Lexicons
5356

54-
Orchestration API layer that collects...stuff...
57+
This is the glue that makes _npmx.dev_ data understandable to other ATProto apps. We utilize custom Lexicons to define the schema for _npmx.dev_ specific record types, such as our social features, package reviews, or documentation comments.
5558

5659
> Lexicon is a schema definition language used to describe atproto records, HTTP endpoints (XRPC), and event stream messages.
5760
58-
https://atproto.com/specs/lexicon
59-
60-
### Standard Site Sync
61-
62-
Synchronizes data changes from npmx.dev in the form of blog post MD files...
61+
For more details refer to the official ATProto docs [here](https://atproto.com/specs/lexicon).
6362

6463
### Personal Data Servers (PDS)
6564

6665
The canonical source for a user identity, a PDS instance provides a substrate upon which to host user accounts and provide account management services.
6766

6867
> Personal data servers, or PDSes, are your home in the cloud. They host your data, distribute it, manage your identity, and orchestrate requests to other services to give you your views.
6968
70-
If you’re wanting to migrate to _npmx.dev_’s PDS then the primary means is to leverage [PDS MOOver](https://pdsmoover.com/moover/npmx.social), made by the community's own @bailey-townsend. If you need further support migrating please join the community [Discord](https://chat.npmx.dev) and refer to the `#pds` channel.
69+
If you’re wanting to migrate to _npmx.dev_’s self-hosted PDS then the primary means is to leverage [PDS MOOver](https://pdsmoover.com/moover/npmx.social), made by the community's own <a href="https://bsky.app/profile/baileytownsend.dev" target="_blank" rel="noopener noreferrer">@baileytownsend.dev</a>. If you need further support migrating then please join the community [Discord](https://chat.npmx.dev) and refer to the `#pds` channel.
7170

7271
For more details refer to the official ATProto docs [here](https://atproto.com/guides/the-at-stack#pds).
7372

73+
### Standard Site Sync
74+
75+
The mechanism for ensuring state consistency between _npmx.dev_ and our self-hosted PDS. Standard Site Sync acts as a specialized repository synchronization layer that translates changes from the _npmx.dev_ platform, such as when we publish a new blog post in the form of a Markdown file, into valid ATProto records that are then pushed to a user's PDS. This ensures that content created on _npmx.dev_ lives permanently in the user's data repository.
76+
7477
### Bluesky Social Graph
7578

76-
Collects and generates events to utilize Posts/Comments/Threads
79+
We actively consume the Bluesky App View to integrate social interactions directly into the user experience. This allows us to utilize those events to display `Posts/Comments/Threads` on our blog posts, add likes to packages, and more. We hope to one day attach relevant articles to packages such as those by the author and see `likes` or `reposts` on technical articles, all without having to leave the _npmx.dev_ environment.
7780

7881
---
7982

@@ -90,10 +93,10 @@ These are the components that allow for _npmx.dev_ to exist as an app on the Atm
9093

9194
## Resources
9295

93-
These are the components that allow for _npmx.dev_ to exist as an app on the Atmosphere:
96+
Consult these resources for further information:
9497

9598
- **ATProtocol Docs** - [Introduction](https://atproto.com)
9699
- **Constellation Repo** - [readme.md](https://github.com/at-microcosm/microcosm-rs/tree/main/constellation)
97-
- **Bluesky** - [Disocover Page](https://bsky.app/)
100+
- **Bluesky** - [Discover Page](https://bsky.app/)
98101

99102
---

0 commit comments

Comments
 (0)