atproto-website

This repository contains the documentation for the AT Protocol, available to read at atproto.com.

To read documentation for the Bluesky API, go to docs.bsky.app or this repo.

Making edits to atproto.com

  • clone this repo
  • run npm install
  • run the development server with npm run dev or yarn dev
  • open http://localhost:3000 with your browser.

src/app/[locale]/en.mdx generates http://localhost:3000 -- start there if you'd like to make changes.

The page auto-updates as you edit the file.

Are you a developer interested in building on atproto?

Bluesky is an open social network built on the AT Protocol, a flexible technology that will never lock developers out of the ecosystems that they help build. With atproto, third-party can be as seamless as first-party through custom feeds, federated services, clients, and more.

License

Documentation text and the atproto specifications are under Creative Commons Attribution (CC-BY).

Inline code examples, example data, and regular expressions are under Creative Commons Zero (CC-0, aka Public Domain) and copy/pasted without attribution.

Please see LICENSE.txt with reminders about derivative works, and LICENSE-CC-BY.txt for a copy of license legal text.