Docs: improve docs narrative around "ENSNode Plugins", "ENSDb Writers", and "ENSDb Readers".

docs/ensnode.io/astro.config.mjs

@@ -70,6 +70,9 @@ export default defineConfig({
       "/docs/integrate/ens-subgraph/examples/with-ensjs",
     "/docs/reference/subgraph-legacy/with-viem": "/docs/integrate/ens-subgraph/examples/with-viem",
     "/docs/reference/subgraph-legacy/subgraph-dependents": "/docs/integrate/ens-subgraph",
+    "/docs/services/ensdb/usage": "/docs/services/ensdb/integrations",
+    "/docs/services/ensdb/usage/sdk": "/docs/integrate/unigraph/examples",
+    "/docs/services/ensdb/usage/sql": "/docs/integrate/unigraph/examples",
     "/ensadmin": "/docs/services/ensadmin",
     "/ensapi": "/docs/services/ensapi",
     "/ensdb": "/docs/services/ensdb",

docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.ts

@@ -218,6 +218,18 @@ export const integrateSidebarTopic = {
           label: "ENSDb (SQL)",
           link: "/docs/integrate/integration-options/ensdb",
         },
+        {
+          label: "ENSDb Writers (Indexers)",
+          link: "/docs/integrate/integration-options/ensdb-writers",
+        },
+        {
+          label: "ENSDb Readers (Custom APIs)",
+          link: "/docs/integrate/integration-options/ensdb-readers",
+        },
+        {
+          label: "ENSNode Plugins (data models)",
+          link: "/docs/integrate/integration-options/ensnode-plugins",
+        },
         {
           label: "enscli (CLI)",
           link: "/docs/integrate/integration-options/enscli",
@@ -227,7 +239,7 @@ export const integrateSidebarTopic = {
           link: "/docs/integrate/integration-options/ensskills",
         },
         {
-          label: "ensdb-cli (ENSDb Snapshots)",
+          label: "ensdb-cli (Snapshots)",
           link: "/docs/integrate/integration-options/ensdb-cli",
         },
         {

docs/ensnode.io/config/integrations/starlight/sidebar-topics/services.ts

@@ -46,28 +46,11 @@ export const servicesSidebarTopic = {
             { label: "Database Schemas", link: "/docs/services/ensdb/concepts/database-schemas" },
           ],
         },
+        { label: "Integrations", link: "/docs/services/ensdb/integrations" },
+
         {
-          label: "Usage",
-          collapsed: true,
-          items: [
-            { label: "Overview", link: "/docs/services/ensdb/usage" },
-            { label: "ENSDb SDK", link: "/docs/services/ensdb/usage/sdk" },
-            { label: "ENSDb SQL", link: "/docs/services/ensdb/usage/sql" },
-          ],
-        },
-        {
-          label: "Integrations",
-          collapsed: true,
-          items: [
-            {
-              label: "ENSNode Reference Implementation",
-              link: "/docs/services/ensdb/integrations/ensnode",
-            },
-            {
-              label: "Future Possibilities",
-              link: "/docs/services/ensdb/integrations/future-possibilities",
-            },
-          ],
+          label: "Reference Implementation",
+          link: "/docs/services/ensdb/reference-implementation",
         },
       ],
     },
@@ -91,7 +74,7 @@ export const servicesSidebarTopic = {
           items: [
             { label: "Overview", link: "/docs/services/ensindexer/contributing" },
             {
-              label: "Creating a Plugin",
+              label: "Creating an ENSNode Plugin",
               link: "/docs/services/ensindexer/contributing/creating-a-plugin",
             },
           ],

docs/ensnode.io/src/content/docs/docs/hosted-instances.mdx

@@ -10,6 +10,8 @@ import HostedEnsNodeInstance from "@components/molecules/HostedEnsNodeInstance.a
 import HostedInstanceSdkVersionWarning from "@components/molecules/HostedInstanceSdkVersionWarning.astro";
 import EnsSubgraphCorrectnessPostEnsV2Launch from "@components/molecules/EnsSubgraphCorrectnessPostEnsV2Launch.astro";
 
+export const pluginLink = (pluginName) => `<a href="/docs/integrate/integration-options/ensnode-plugins#existing-plugins" class="underline">${pluginName}</a>`;
+
 export const subgraphCompatibilityApiLevel = `<em>API-level Subgraph Compatibility.</em> This ENSNode instance has a fully backwards compatible ENS Subgraph GraphQL API. However, additional plugins have been activated which index a superset of data into the subgraph data model in ENSDb. This superset of indexed data means that the data returned for some ENS Subgraph API queries may be different.`;
 export const subgraphCompatibilityFull = `<em>Full Subgraph Compatibility.</em> This ENSNode instance has a fully backwards compatible ENS Subgraph GraphQL API at both the API-level and the data-level. We have exhaustively tested and verified that every data record returned by this ENSNode instance's ENS Subgraph API is byte-for-byte identical with The Graph's ENS Subgraph API.`;
 export const omnigraphForEnsV1 = `<em>Activated.</em> Demonstrates the ENS Omnigraph's ability to support ENSv1 only before ENSv2 launches and both ENSv1 and ENSv2 are concurrently active. Until ENSv2 launches on this namespace, only ENSv1 domains will be available. As soon as ENSv2 launches on this namespace both ENSv1 and ENSv2 domains will be available.`;
@@ -50,7 +52,7 @@ More details about ENS namespaces can be found inside [ENSNode's datasources pac
 
 ### ENSNode Plugins
 
-Each ENSNode instance is also configured for a specific set of activated **ENSNode plugins**.
+Each ENSNode instance is also configured for a specific set of activated [ENSNode plugins](/docs/integrate/integration-options/ensnode-plugins).
 
 The activated plugins determine the specific indexed data model and data records ENSIndexer will produce in ENSDb and therefore which APIs and data records ENSApi will make available to query.
 
@@ -69,7 +71,7 @@ The `sepolia-v2` namespace is undergoing active development by the ENS Labs team
   connectWithENSAdminURL="https://admin.ensnode.io/connection?connection=https%3A%2F%2Fapi.v2-sepolia.ensnode.io"
   namespace="sepolia-v2"
   ensVersions="ENSv1 + ENSv2 (concurrently activated together)"
-  plugins="<em>unigraph</em>, <em>protocol-acceleration</em>, <em>subgraph</em>"
+  plugins={`${pluginLink("unigraph")}, ${pluginLink("protocol-acceleration")}, ${pluginLink("subgraph")}`}
   >
   <Fragment slot="ens-omnigraph-api-icon" set:text={"✅"} />
   <Fragment slot="ens-omnigraph-api" set:html={omnigraphForEnsV1AndEnsV2} />
@@ -99,7 +101,7 @@ These ENSNode instances do not constrain themselves to exclusively activating th
   connectWithENSAdminURL="https://admin.ensnode.io/connection?connection=https%3A%2F%2Fapi.alpha.ensnode.io"
   namespace="mainnet"
   ensVersions="ENSv1 only (not also ENSv2 yet)"
-  plugins="<em>unigraph</em>, <em>protocol-acceleration</em>, <em>subgraph</em>, basenames, lineanames, threedns, registrars, tokenscope"
+  plugins={`${pluginLink("unigraph")}, ${pluginLink("protocol-acceleration")}, ${pluginLink("subgraph")}, ${pluginLink("basenames")}, ${pluginLink("lineanames")}, ${pluginLink("threedns")}, ${pluginLink("registrars")}, ${pluginLink("tokenscope")}`}
 >
   <Fragment slot="ens-omnigraph-api-icon" set:text={"✅"} />
   <Fragment slot="ens-omnigraph-api" set:html={omnigraphForEnsV1} />
@@ -121,7 +123,7 @@ These ENSNode instances do not constrain themselves to exclusively activating th
   connectWithENSAdminURL="https://admin.ensnode.io/connection?connection=https%3A%2F%2Fapi.alpha-sepolia.ensnode.io"
   namespace="sepolia"
   ensVersions="ENSv1 only (not also ENSv2 yet)"
-  plugins="<em>unigraph</em>, <em>protocol-acceleration</em>, <em>subgraph</em>, basenames, lineanames, registrars"
+  plugins={`${pluginLink("unigraph")}, ${pluginLink("protocol-acceleration")}, ${pluginLink("subgraph")}, ${pluginLink("basenames")}, ${pluginLink("lineanames")}, ${pluginLink("registrars")}`}
   >
   <Fragment slot="ens-omnigraph-api-icon" set:text={"✅"} />
   <Fragment slot="ens-omnigraph-api" set:html={omnigraphForEnsV1} />
@@ -147,7 +149,7 @@ These ENSNode instances focus on maximizing backwards compatibility with the ENS
   connectWithENSAdminURL="https://admin.ensnode.io/connection?connection=https%3A%2F%2Fapi.mainnet.ensnode.io"
   namespace="mainnet"
   ensVersions="ENSv1 only (not also ENSv2 yet)"
-  plugins="<em>subgraph</em>"
+  plugins={`${pluginLink("subgraph")}`}
   >
   <Fragment slot="ens-omnigraph-api-icon" set:text={"❌"} />
   <Fragment slot="ens-omnigraph-api" set:html={omnigraphUnactivated} />
@@ -169,7 +171,7 @@ These ENSNode instances focus on maximizing backwards compatibility with the ENS
   connectWithENSAdminURL="https://admin.ensnode.io/connection?connection=https%3A%2F%2Fapi.sepolia.ensnode.io"
   namespace="sepolia"
   ensVersions="ENSv1 only (not also ENSv2 yet)"
-  plugins="<em>subgraph</em>"
+  plugins={`${pluginLink("subgraph")}`}
   >
   <Fragment slot="ens-omnigraph-api-icon" set:text={"❌"} />
   <Fragment slot="ens-omnigraph-api" set:html={omnigraphUnactivated} />

docs/ensnode.io/src/content/docs/docs/integrate/index.mdx

@@ -155,6 +155,9 @@ The ENS Omnigraph API is a GraphQL API following the Relay specification, so you
 Beyond [`enssdk`](/docs/integrate/integration-options/enssdk), [`enskit`](/docs/integrate/integration-options/enskit), and the [Omnigraph GraphQL API](/docs/integrate/integration-options/omnigraph-graphql-api), ENSNode exposes a deeper set of integration surfaces for advanced use cases:
 
 - **[ENSDb (SQL)](/docs/integrate/integration-options/ensdb)** — query the indexed ENSv1 and ENSv2 datasets directly via SQL for custom analytics or your own service layer, from any language with a Postgres driver.
+- **[ENSDb Writers (Indexers)](/docs/integrate/integration-options/ensdb-writers)** — build your own ENSDb Writer to index ENS data into your own ENSDb instance.
+- **[ENSDb Readers](/docs/integrate/integration-options/ensdb-readers)** — build your own ENSDb Reader to query your own ENSDb instance through any interface of your choice.
+- **[ENSNode Plugins](/docs/integrate/integration-options/ensnode-plugins)** — define how onchain data should be indexed into ENSDb.
 - **[enscli (CLI)](/docs/integrate/integration-options/enscli)** — resolve names, look up records, and run ad-hoc Omnigraph queries from the terminal — built for humans and AI agents alike.
 - **[ensskills (AI agents)](/docs/integrate/integration-options/ensskills)** — a curated set of skills that gives AI coding agents a well-defined contract for working with ENS.
 - **[ensdb-cli (ENSDb Snapshots)](/docs/integrate/integration-options/ensdb-cli)** — bootstrap a fresh ENSDb in minutes from portable, versioned snapshots instead of waiting days on a full historical backfill.

docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb-readers.mdx

@@ -0,0 +1,54 @@
+---
+title: ENSDb Readers (Custom APIs)
+description: How to build custom APIs and other services on top of ENSDb, using the ENSDb Reader standard.
+---
+
+import { LinkCard } from "@astrojs/starlight/components";
+
+An [ENSDb Reader](/docs/services/ensdb/concepts/glossary#ensdb-reader) is any service that interacts with ENSDb to read ENS data. This can be anything from a custom GraphQL or REST API, to a data analytics pipeline, to a command-line interface, to a dashboard, and more.
+
+:::tip[Build your own ENSDb Reader]
+You can build your own ENSDb Reader in any language, using any framework, as long as you follow the [ENSDb Standard](/docs/services/ensdb/concepts/glossary#ensdb-standard). The ENSDb Standard defines rules and constraints for how an ENSDb Reader should read data from an ENSDb instance in a way that maintains the integrity of the data and supports interoperability with any ENSDb Writer.
+:::
+
+## Current ENSDb Readers
+
+### ENSApi
+
+ENSApi is a reference implementation of an [ENSDb Reader](/docs/services/ensdb/concepts/glossary#ensdb-reader) that includes the following APIs:
+
+- The new [ENS Omnigraph GraphQL API](/docs/integrate/integration-options/omnigraph-graphql-api) that's built on top of [ENSNode Plugins](/docs/integrate/integration-options/ensnode-plugins) such as `unigraph` and `protocol-acceleration`.
+- A backwards-compatible [ENS Subgraph GraphQL API](/docs/integrate/ens-subgraph) that's built on top of [ENSNode Plugins](/docs/integrate/integration-options/ensnode-plugins) such as `subgraph`, `basenames`, `lineanames`, and `threedns`.
+- APIs for various queries related to the metadata stored in ENSDb, such as the indexing status from the [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) and [metadata](/docs/services/ensdb/concepts/glossary#indexing-metadata-context) about the overall [ENSNode stack of services](/docs/services) active in the ENSNode instance.
+
+<LinkCard
+  title="Learn more about ENSApi"
+  description="A reference implementation of ENSDb Reader, built by the NameHash team."
+  href="/docs/services/ensapi"
+/>
+
+### New ENSDb Readers Under Development
+
+Multiple new [ENSDb Reader](/docs/services/ensdb/concepts/glossary#ensdb-reader) services are planned by the NameHash team. Find out more about each of them below.
+
+<LinkCard
+  title="Learn more about ensdb-cli"
+  description="A command-line interface for interacting with ENSDb."
+  href="/docs/integrate/integration-options/ensdb-cli"
+/>
+
+<LinkCard
+  title="Learn more about ENSEngine"
+  description="A push-based web service allowing you to track ENS data changes as they occur."
+  href="/docs/integrate/integration-options/ensengine"
+/>
+
+<LinkCard
+  title="Learn more about ENSAnalytics (coming soon)"
+  description="A web service that provides analytics and insights on ENS data."
+  href="/docs/services"
+/>
+
+:::note[Build your own ENSDb Reader]
+Creating your own ENSDb Reader service enables you to build your own completely custom APIs and data pipeline services. See related inspiration on the [ENSDb integration options page](/docs/integrate/integration-options/ensdb). Use any programming language or framework you wish! If you'd like any help or guidance, feel welcome to reach out to the NameHash team on [Telegram](https://t.me/ensnode).
+:::

docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb-writers.mdx

@@ -0,0 +1,44 @@
+---
+title: ENSDb Writers (Indexers)
+description: How to build your own custom indexer implementation for ENSDb, using the ENSDb Writer specification.
+---
+
+import { LinkCard } from "@astrojs/starlight/components";
+
+An [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) is the implementation of an indexing service that implements one or more standards-compliant [ENSNode plugins](/docs/integrate/integration-options/ensnode-plugins) and implements a standards-compliant [ENSDb Metadata Writer](/docs/services/ensdb/concepts/glossary#ensdb-metadata-writer) that stores [metadata](/docs/services/ensdb/concepts/glossary#indexing-metadata-context) about the [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer).
+
+:::tip[Build your own ENSDb Writer]
+You can build your own ENSDb Writer in any language, using any indexing framework, as long as you follow the [ENSDb Standard](/docs/services/ensdb/concepts/glossary#ensdb-standard). The ENSDb Standard defines rules and constraints for how an ENSDb Writer should write data into an ENSDb instance in a way that maintains the integrity of the data and supports interoperability with any ENSDb Reader.
+
+Your ENSDb Writer must include:
+
+- The _implementation_ of 1 or more standards-compliant [ENSNode plugins](/docs/integrate/integration-options/ensnode-plugins).
+- The _implementation_ of an [ENSDb Metadata Writer](/docs/services/ensdb/concepts/glossary#ensdb-metadata-writer) that stores [metadata](/docs/services/ensdb/concepts/glossary#indexing-metadata-context) about the [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) overall, including which [ENSNode Plugins](/docs/integrate/integration-options/ensnode-plugins) it has activated, what the status of indexing is across each indexed chain, etc.
+
+:::
+
+## Current ENSDb Writers
+
+### ENSIndexer
+
+[ENSIndexer](/docs/services/ensindexer) is a reference implementation of an [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) built by the NameHash team. It is a multi-chain ENS indexer built on top of [Ponder](https://ponder.sh/) that implements many ENSNode Plugins.
+
+<LinkCard
+  title="Learn more about ENSIndexer"
+  description="A reference implementation of ENSDb Writer, built by the NameHash team."
+  href="/docs/services/ensindexer"
+/>
+
+## New ENSDb Writers Under Development or Discussions
+
+### Envio
+
+The [Envio](https://envio.dev/) team is actively collaborating with NameHash Labs to build another standards-compliant [ENSDb Writer](/docs/services/ensdb/concepts/glossary#ensdb-writer) that uses Envio as the indexing engine. Their initial ENSNode plugin under development is `subgraph`, with plans to support `unigraph` after that.
+
+### Amp (Edge & Node)
+
+[Edge & Node](https://www.edgeandnode.com) has discussions scheduled with the NameHash Labs team to investigate the use of their new [Amp](https://www.edgeandnode.com/articles/stream-live-chain-data-into-your-analytics-stack-with-amp) platform to implement an ENSDb Writer.
+
+### Build Your Own
+
+You can build your own ENSDb Writer in any language, using any indexing framework, as long as you follow the [ENSDb Standard](/docs/services/ensdb/concepts/glossary#ensdb-standard). Join us on [Telegram](https://t.me/ensnode) for any questions and support.