diff --git a/README.md b/README.md index 6b21a18e..8bbe3053 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ _Diffuse is a few things:_ - A collection of custom DOM elements (aka. framework-agnostic web components) that allow you to build an audio player, do audio metadata processing and browsing, list audio files and streams from various sources/APIs/servers, define how to save or sync user-data, etc. - A HTML loader that loads "interfaces" from the local user-data cache, the default set from Diffuse, HTTP(S) URLs, or [AT Protocol](https://atproto.com) URIs. When you load an interface, it's supplied with optional "features" which are also pieces of HTML. These pieces are called "facets" and are loaded from the local user-data cache as well. - A default configuration of the custom elements that's called "the foundation". This is used throughout the default set of facets. This foundation is configured so that the facets can communicate across tabs/frames; this is done by setting the element's `group` attribute. -- A collection of data schemas in the form of atproto [lexicons](https://atproto.com/specs/lexicon). These live in the `definitions` directory. +- A collection of data schemas in the form of atproto [lexicons](https://atproto.com/specs/lexicon). These live in the `lexicons` directory. Putting all of this together to make cooperative and [malleable](https://www.inkandswitch.com/essay/malleable-software/) software. More information on the [website](https://elements.diffuse.sh/). diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 23c8f439..aa335663 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -26,7 +26,7 @@ Components share state with each other using signals (see `common/signal.js`) or ## Definitions -`src/definitions/` are atproto lexicons, JSON schemas that describe data in the system. +`lexicons/` are atproto lexicons, JSON schemas that describe data in the system. The generated TypeScript types live in `src/definitions/`. diff --git a/lexicon.config.js b/lexicon.config.js index 096861a9..c20e0d77 100644 --- a/lexicon.config.js +++ b/lexicon.config.js @@ -1,6 +1,6 @@ import { defineLexiconConfig } from "@atcute/lex-cli"; export default defineLexiconConfig({ - files: ["src/definitions/**/*.json"], + files: ["lexicons/**/*.json"], outdir: "src/definitions/", }); diff --git a/src/definitions/output/collaboration.json b/lexicons/output/collaboration.json similarity index 100% rename from src/definitions/output/collaboration.json rename to lexicons/output/collaboration.json diff --git a/src/definitions/output/facet.json b/lexicons/output/facet.json similarity index 100% rename from src/definitions/output/facet.json rename to lexicons/output/facet.json diff --git a/src/definitions/output/playlistItem.json b/lexicons/output/playlistItem.json similarity index 100% rename from src/definitions/output/playlistItem.json rename to lexicons/output/playlistItem.json diff --git a/src/definitions/output/playlistItemBundle.json b/lexicons/output/playlistItemBundle.json similarity index 100% rename from src/definitions/output/playlistItemBundle.json rename to lexicons/output/playlistItemBundle.json diff --git a/src/definitions/output/setting.json b/lexicons/output/setting.json similarity index 100% rename from src/definitions/output/setting.json rename to lexicons/output/setting.json diff --git a/src/definitions/output/track.json b/lexicons/output/track.json similarity index 100% rename from src/definitions/output/track.json rename to lexicons/output/track.json diff --git a/src/definitions/output/trackBundle.json b/lexicons/output/trackBundle.json similarity index 100% rename from src/definitions/output/trackBundle.json rename to lexicons/output/trackBundle.json